From a681cb7ad9a3ec00c8aeba3a92dd7159dab3beee Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Wed, 3 Feb 2016 11:39:40 -0800 Subject: [PATCH 1/3] Add links to dedicated pages describing each Element. --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c7941c2c9f..2111323605 100644 --- a/README.md +++ b/README.md @@ -32,13 +32,13 @@ https://github.com/ElementsProject/elements/tree/alpha Elements Alpha is the Elements project's first experimental test chain. Compared to Bitcoin itself, it adds the following features: - * Confidential Transactions - * Segregated Witness - * Relative Lock Time - * Schnorr Signatures - * Additional opcodes - * Deterministic Peg (pegged to Bitcoin's testnet currency). - * Signed Blocks + * [Confidential Transactions][confidential-transactions] + * [Segregated Witness][segregated-witness] + * [Relative Lock Time][relative-lock-time] + * [Schnorr Signatures][schnorr-signatures] + * [Additional opcodes][opcodes] + * [Deterministic Peg (pegged to Bitcoin's testnet currency).][deterministic-peg] + * [Signed Blocks][signed-blocks] See alpha-README.md for build and use instructions. @@ -47,3 +47,11 @@ License Elements Alpha is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT. + +[confidential-transactions]: https://www.elementsproject.org/elements/confidential-transactions +[segregated-witness]: https://www.elementsproject.org/elements/segregated-witness +[relative-lock-time]: https://www.elementsproject.org/elements/relative-lock-time +[schnorr-signatures]: https://www.elementsproject.org/elements/schnorr-signatures +[opcodes]: https://www.elementsproject.org/elements/opcodes +[deterministic-peg]: https://www.elementsproject.org/elements/deterministic-peg +[signed-blocks]: https://www.elementsproject.org/elements/signed-blocks From 932e66b6c626cff2cf9080009a2ba4c4003c39e3 Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Wed, 3 Feb 2016 11:48:21 -0800 Subject: [PATCH 2/3] Add and improve verbiage and messaging. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2111323605..9554ca6d5a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -Elements integration/staging tree +The Elements Project ================================= +This is the integration and staging tree for the Elements Project, a series of +improvements and extensions to the Bitcoin protocol. What is Bitcoin? ---------------- @@ -15,14 +17,15 @@ software which enables the use of this currency. For more information, as well as an immediately useable, binary version of the Bitcoin Core software, see https://www.bitcoin.org/en/download. -What is Sidechain Elements? +What is the Elements Projects? ----------------- -Sidechain Elements is a collection of experiments to bring more technical innovation to Bitcoin. +The Elements Project is a collection of experiments, aiming to bring greater +technical innovation to Bitcoin. https://github.com/ElementsProject/elementsproject.github.io -Read details and future in the project documentation +Learn more on [the Elements Project website](https://www.elementsproject.org). What is Elements Alpha? ----------------------- From 5f5ebe29ddaa2596f8b642032e17325db0b4fadd Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Wed, 3 Feb 2016 12:00:08 -0800 Subject: [PATCH 3/3] Re-organize the flow of the README, include Quick Start. Fix typos. --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9554ca6d5a..41947fb36f 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,19 @@ The Elements Project This is the integration and staging tree for the Elements Project, a series of improvements and extensions to the Bitcoin protocol. +What is the Elements Project? +----------------- +Elements is an open source collaborative project where we work on a collection +of experiments to more rapidly bring technical innovation to Bitcoin. Elements +are features that are proposed and developed in this technical community that in +arbitrary combinations can be fashioned into sidechains. + +https://github.com/ElementsProject/elementsproject.github.io + +Learn more on [the Elements Project website](https://www.elementsproject.org). + What is Bitcoin? ---------------- - https://www.bitcoin.org Bitcoin is an experimental new digital currency that enables instant payments to @@ -17,19 +27,8 @@ software which enables the use of this currency. For more information, as well as an immediately useable, binary version of the Bitcoin Core software, see https://www.bitcoin.org/en/download. -What is the Elements Projects? ------------------ - -The Elements Project is a collection of experiments, aiming to bring greater -technical innovation to Bitcoin. - -https://github.com/ElementsProject/elementsproject.github.io - -Learn more on [the Elements Project website](https://www.elementsproject.org). - What is Elements Alpha? ----------------------- - https://github.com/ElementsProject/elements/tree/alpha Elements Alpha is the Elements project's first experimental test chain. @@ -43,11 +42,12 @@ Compared to Bitcoin itself, it adds the following features: * [Deterministic Peg (pegged to Bitcoin's testnet currency).][deterministic-peg] * [Signed Blocks][signed-blocks] +Getting Started +--------------- See alpha-README.md for build and use instructions. License ------- - Elements Alpha is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT. @@ -56,5 +56,5 @@ information or see http://opensource.org/licenses/MIT. [relative-lock-time]: https://www.elementsproject.org/elements/relative-lock-time [schnorr-signatures]: https://www.elementsproject.org/elements/schnorr-signatures [opcodes]: https://www.elementsproject.org/elements/opcodes -[deterministic-peg]: https://www.elementsproject.org/elements/deterministic-peg +[deterministic-peg]: https://www.elementsproject.org/elements/deterministic-pegs [signed-blocks]: https://www.elementsproject.org/elements/signed-blocks