diff --git a/README.md b/README.md index a5ebc84414..d81157c21f 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,65 @@ -Bitcoin Core integration/staging tree -===================================== +Elements Project blockchain platform +==================================== -[![Build Status](https://travis-ci.org/bitcoin/bitcoin.svg?branch=master)](https://travis-ci.org/bitcoin/bitcoin) +[![Build Status](https://travis-ci.org/ElementsProject/elements.svg?branch=master)](https://travis-ci.org/ElementsProject/elements) -https://bitcoincore.org +https://elementsproject.org -What is Bitcoin? ----------------- - -Bitcoin is an experimental digital currency that enables instant payments to -anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate -with no central authority: managing transactions and issuing money are carried -out collectively by the network. Bitcoin Core is the name of open source -software which enables the use of this currency. +This is the integration and staging tree for the Elements blockchain platform, +a collection of feature experiments and extensions to the Bitcoin protocol. +This platform enables anyone to build their own businesses or networks +pegged to Bitcoin as a sidechain or run as a standalone blockchain with arbitrary asset tokens. -For more information, as well as an immediately useable, binary version of -the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the -[original whitepaper](https://bitcoincore.org/bitcoin.pdf). +Confidential Assets +---------------- +The latest feature in the Elements blockchain platform is Confidential Assets, +the ability to issue multiple assets on a blockchain where asset identifiers +and amounts are blinded yet auditable through the use of applied cryptography. -License -------- + * [Announcement of Confidential Assets](https://blockstream.com/2017/04/03/blockstream-releases-elements-confidential-assets.html) + * [Confidential Assets Whitepaper](https://blockstream.com/bitcoin17-final41.pdf) to be presented [April 7th at Financial Cryptography 2017](http://fc17.ifca.ai/bitcoin/schedule.html) in Malta + * [Confidential Assets Tutorial](contrib/assets_tutorial/assets_tutorial.sh) + * [Confidential Assets Demo](https://github.com/ElementsProject/confidential-assets-demo) + * [Elements Code Tutorial](https://elementsproject.org/elements-code-tutorial/overview) covering blockchain configuration and how to use the main features. -Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more -information or see https://opensource.org/licenses/MIT. +Features of the Elements blockchain platform +---------------- -Development Process -------------------- +Compared to Bitcoin itself, it adds the following features: + * [Confidential Assets][asset-issuance] + * [Confidential Transactions][confidential-transactions] + * [Federated Two-Way Peg][federated-peg] + * [Signed Blocks][signed-blocks] + * [Additional opcodes][opcodes] -The `master` branch is regularly built and tested, but is not guaranteed to be -completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created -regularly to indicate new official, stable release versions of Bitcoin Core. +Previous elements that have been integrated into Bitcoin: + * Segregated Witness + * Relative Lock Time -The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md). +Elements deferred for additional research and standardization: + * [Schnorr Signatures][schnorr-signatures] -Testing +License ------- +Elements is released under the terms of the MIT license. See [COPYING](COPYING) for more +information or see http://opensource.org/licenses/MIT. -Testing and code review is the bottleneck for development; we get more pull -requests than we can review and test on short notice. Please be patient and help out by testing -other people's pull requests, and remember this is a security-critical project where any mistake might cost people -lots of money. - -### Automated Testing +[confidential-transactions]: https://elementsproject.org/features/confidential-transactions +[opcodes]: https://elementsproject.org/features/opcodes +[federated-peg]: https://elementsproject.org/features#federatedpeg +[signed-blocks]: https://elementsproject.org/features#signedblocks +[asset-issuance]: https://elementsproject.org/features/issued-assets +[schnorr-signatures]: https://elementsproject.org/features/schnorr-signatures -Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to -submit new unit tests for old code. Unit tests can be compiled and run -(assuming they weren't disabled in configure) with: `make check`. Further details on running -and extending unit tests can be found in [/src/test/README.md](/src/test/README.md). +What is the Elements Project? +----------------- +Elements is an open source, sidechain-capable blockchain platform. It also allows experiments to more rapidly bring technical innovation to the Bitcoin ecosystem. -There are also [regression and integration tests](/test), written -in Python, that are run automatically on the build server. -These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py` +Learn more on the [Elements Project website](https://elementsproject.org) -The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically. - -### Manual Quality Assurance (QA) Testing - -Changes should be tested by somebody other than the developer who wrote the -code. This is especially important for large or high-risk changes. It is useful -to add a test plan to the pull request description if testing the changes is -not straightforward. - -Translations ------------- - -Changes to translations as well as new translations can be submitted to -[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/). - -Translations are periodically pulled from Transifex and merged into the git repository. See the -[translation process](doc/translation_process.md) for details on how this works. - -**Important**: We do not accept translation changes as GitHub pull requests because the next -pull from Transifex would automatically overwrite them again. - -Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators). +https://github.com/ElementsProject/elementsproject.github.io Secure Reporting ------------------ -See [our vulnerability reporting guide](SECURITY.md) \ No newline at end of file +See [our vulnerability reporting guide](SECURITY.md) +