+
## The fastest and most advanced Ethereum client.
@@ -22,8 +22,6 @@ Or join our community on Matrix:
Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
-----
-
## About Parity-Ethereum
Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs.
@@ -34,8 +32,6 @@ If you run into problems while using Parity-Ethereum, feel free to file an issue
Parity-Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
-----
-
## Build dependencies
**Parity-Ethereum requires Rust version 1.27.0 to build**
@@ -69,8 +65,6 @@ Once you have rustup installed, then you need to install:
Make sure that these binaries are in your `PATH`. After that you should be able to build Parity-Ethereum from source.
-----
-
## Install from the snap store
In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
@@ -91,8 +85,6 @@ And to test the latest code landed into the master branch:
sudo snap install parity --edge
```
-----
-
## Build from source
```bash
@@ -132,8 +124,6 @@ $ git checkout beta
first.
-----
-
## Simple one-line installer for Mac and Ubuntu
```bash
From 38b6db764ddd681d38c6ac65f64e9c0101c265c1 Mon Sep 17 00:00:00 2001
From: 5chdn <5chdn@users.noreply.github.com>
Date: Fri, 24 Aug 2018 15:22:07 -0400
Subject: [PATCH 5/8] docs: restructure readme
---
README.md | 34 +++++++++++++++++++++-------------
1 file changed, 21 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index f498d27216f..a652c743fce 100644
--- a/README.md
+++ b/README.md
@@ -9,20 +9,15 @@
-### Join the chat!
+**Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Parity Ethereum provides the core infrastructure essential for speedy and reliable services.
-Get in touch with us on Gitter:
-[](https://gitter.im/paritytech/parity)
-[](https://gitter.im/paritytech/parity.js)
-[](https://gitter.im/paritytech/parity/miners)
-[](https://gitter.im/paritytech/parity-poa)
+- Clean, modular codebase for easy customisation
+- Advanced CLI-based client
+- Minimal memory and storage footprint
+- Synchronise in hours, not days with Warp Sync
+- Modular for light integration into your service or product
-Or join our community on Matrix:
-[](https://riot.im/app/#/group/+parity:matrix.parity.io)
-
-Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
-
-## About Parity-Ethereum
+## Overview
Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs.
@@ -34,7 +29,7 @@ Parity-Ethereum's current beta-release is 2.0. You can download it at [the relea
## Build dependencies
-**Parity-Ethereum requires Rust version 1.27.0 to build**
+**Parity-Ethereum requires Rust version 1.28.x to build**
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
@@ -155,3 +150,16 @@ To start Parity-Ethereum as a regular user using systemd init:
1. Copy `./scripts/parity.service` to your
systemd user directory (usually `~/.config/systemd/user`).
2. To configure Parity-Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity-Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
+
+### Join the chat!
+
+Questions? Get in touch with us on Gitter:
+[](https://gitter.im/paritytech/parity)
+[](https://gitter.im/paritytech/parity.js)
+[](https://gitter.im/paritytech/parity/miners)
+[](https://gitter.im/paritytech/parity-poa)
+
+Or join our community on Matrix:
+[](https://riot.im/app/#/group/+parity:matrix.parity.io)
+
+Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
From 371767bb3e58f6dd73934ff7aed4de195e663b6a Mon Sep 17 00:00:00 2001
From: 5chdn <5chdn@users.noreply.github.com>
Date: Fri, 24 Aug 2018 15:29:37 -0400
Subject: [PATCH 6/8] docs: check spelling and grammar in readme
---
README.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index a652c743fce..25252386c0e 100644
--- a/README.md
+++ b/README.md
@@ -19,9 +19,9 @@
## Overview
-Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3, and can be used for all your Ethereum needs.
+Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
-By default, Parity-Ethereum will run a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
+By default, Parity-Ethereum runs a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
If you run into problems while using Parity-Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
@@ -31,7 +31,7 @@ Parity-Ethereum's current beta-release is 2.0. You can download it at [the relea
**Parity-Ethereum requires Rust version 1.28.x to build**
-We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have rustup, you can install it like this:
+We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
- Linux:
```bash
@@ -48,17 +48,17 @@ We recommend installing Rust through [rustup](https://www.rustup.rs/). If you do
`clang` is required. It comes with Xcode command line tools or can be installed with homebrew.
- Windows
- Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the rustup installer from
- https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the msvc toolchain:
+ Make sure you have Visual Studio 2015 with C++ support installed. Next, download and run the `rustup` installer from
+ https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe, start "VS2015 x64 Native Tools Command Prompt", and use the following command to install and set up the `msvc` toolchain:
```bash
$ rustup default stable-x86_64-pc-windows-msvc
```
-Once you have rustup installed, then you need to install:
+Once you have `rustup` installed, then you need to install:
* [Perl](https://www.perl.org)
* [Yasm](https://yasm.tortall.net)
-Make sure that these binaries are in your `PATH`. After that you should be able to build Parity-Ethereum from source.
+Make sure that these binaries are in your `PATH`. After that, you should be able to build Parity-Ethereum from source.
## Install from the snap store
@@ -68,13 +68,13 @@ In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
sudo snap install parity
```
-Or, if you want to contribute testing the upcoming release:
+Alternatively, if you want to contribute testing the upcoming release:
```bash
sudo snap install parity --beta
```
-And to test the latest code landed into the master branch:
+Moreover, to test the latest code from the master branch:
```bash
sudo snap install parity --edge
@@ -91,7 +91,7 @@ $ cd parity-ethereum
$ cargo build --release --features final
```
-This will produce an executable in the `./target/release` subdirectory.
+This produces an executable in the `./target/release` subdirectory.
Note: if cargo fails to parse manifest try:
@@ -105,7 +105,7 @@ Note, when compiling a crate and you receive errors, it's in most cases your out
$ cargo clean
```
-This will always compile the latest nightly builds. If you want to build stable or beta, do a
+This always compiles the latest nightly builds. If you want to build stable or beta, do a
```bash
$ git checkout stable
@@ -141,14 +141,14 @@ To start Parity-Ethereum manually, just run
$ ./target/release/parity
```
-and Parity-Ethereum will begin syncing the Ethereum blockchain.
+so Parity-Ethereum begins syncing the Ethereum blockchain.
-### Using systemd service file
+### Using `systemd` service file
-To start Parity-Ethereum as a regular user using systemd init:
+To start Parity-Ethereum as a regular user using `systemd` init:
1. Copy `./scripts/parity.service` to your
-systemd user directory (usually `~/.config/systemd/user`).
+`systemd` user directory (usually `~/.config/systemd/user`).
2. To configure Parity-Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity-Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
### Join the chat!
@@ -159,7 +159,7 @@ Questions? Get in touch with us on Gitter:
[](https://gitter.im/paritytech/parity/miners)
[](https://gitter.im/paritytech/parity-poa)
-Or join our community on Matrix:
+Alternatively, join our community on Matrix:
[](https://riot.im/app/#/group/+parity:matrix.parity.io)
Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
From 0c495a17b9b06ad0645f825de8691202dcffc88d Mon Sep 17 00:00:00 2001
From: 5chdn <5chdn@users.noreply.github.com>
Date: Fri, 24 Aug 2018 15:33:40 -0400
Subject: [PATCH 7/8] docs: clarify readme
---
README.md | 42 ++++++++++++++++++++++--------------------
1 file changed, 22 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index 25252386c0e..7fdc8192b08 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-
+
## The fastest and most advanced Ethereum client.
@@ -17,19 +17,19 @@
- Synchronise in hours, not days with Warp Sync
- Modular for light integration into your service or product
-## Overview
+## Technical Overview
-Parity-Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity-Ethereum using the sophisticated and cutting-edge Rust programming language. Parity-Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
+Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge Rust programming language. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
-By default, Parity-Ethereum runs a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
+By default, Parity Ethereum runs a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
-If you run into problems while using Parity-Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
+If you run into problems while using Parity Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
-Parity-Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
+Parity Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
-## Build dependencies
+## Build Dependencies
-**Parity-Ethereum requires Rust version 1.28.x to build**
+Parity Ethereum requires Rust version 1.28.x to build.
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
@@ -38,7 +38,7 @@ We recommend installing Rust through [rustup](https://www.rustup.rs/). If you do
$ curl https://sh.rustup.rs -sSf | sh
```
- Parity-Ethereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
+ Parity Ethereum also requires `gcc`, `g++`, `libudev-dev`, `pkg-config`, `file`, `make`, and `cmake` packages to be installed.
- OSX:
```bash
@@ -58,9 +58,9 @@ Once you have `rustup` installed, then you need to install:
* [Perl](https://www.perl.org)
* [Yasm](https://yasm.tortall.net)
-Make sure that these binaries are in your `PATH`. After that, you should be able to build Parity-Ethereum from source.
+Make sure that these binaries are in your `PATH`. After that, you should be able to build Parity Ethereum from source.
-## Install from the snap store
+## Install from the Snapcraft Store
In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
@@ -80,10 +80,10 @@ Moreover, to test the latest code from the master branch:
sudo snap install parity --edge
```
-## Build from source
+## Build from Source Code
```bash
-# download Parity-Ethereum code
+# download Parity Ethereum code
$ git clone https://github.com/paritytech/parity-ethereum
$ cd parity-ethereum
@@ -119,7 +119,7 @@ $ git checkout beta
first.
-## Simple one-line installer for Mac and Ubuntu
+## Simple One-Line Installer for Mac and Linux
```bash
bash <(curl https://get.parity.io -L)
@@ -131,27 +131,27 @@ The one-line installer always defaults to the latest beta release. To install a
bash <(curl https://get.parity.io -L) -r stable
```
-## Start Parity-Ethereum
+## Start Parity Ethereum
### Manually
-To start Parity-Ethereum manually, just run
+To start Parity Ethereum manually, just run
```bash
$ ./target/release/parity
```
-so Parity-Ethereum begins syncing the Ethereum blockchain.
+so Parity Ethereum begins syncing the Ethereum blockchain.
### Using `systemd` service file
-To start Parity-Ethereum as a regular user using `systemd` init:
+To start Parity Ethereum as a regular user using `systemd` init:
1. Copy `./scripts/parity.service` to your
`systemd` user directory (usually `~/.config/systemd/user`).
-2. To configure Parity-Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity-Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
+2. To configure Parity Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
-### Join the chat!
+## Join the chat!
Questions? Get in touch with us on Gitter:
[](https://gitter.im/paritytech/parity)
@@ -162,4 +162,6 @@ Questions? Get in touch with us on Gitter:
Alternatively, join our community on Matrix:
[](https://riot.im/app/#/group/+parity:matrix.parity.io)
+## Documentation
+
Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
From 0a6930472c642a8253e5251694a96d0ff92d5288 Mon Sep 17 00:00:00 2001
From: 5chdn <5chdn@users.noreply.github.com>
Date: Fri, 24 Aug 2018 15:39:34 -0400
Subject: [PATCH 8/8] docs: improve readme significantly
---
README.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 7fdc8192b08..88138b78cb5 100644
--- a/README.md
+++ b/README.md
@@ -19,17 +19,17 @@
## Technical Overview
-Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge Rust programming language. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
+Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge **Rust programming language**. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
-By default, Parity Ethereum runs a JSON-RPC HTTP server on `127.0.0.1:8545` and a Web-Sockets server on `127.0.0.1:8546`. This is fully configurable and supports a number of APIs.
+By default, Parity Ethereum runs a JSON-RPC HTTP server on port `:8545` and a Web-Sockets server on port `:8546`. This is fully configurable and supports a number of APIs.
-If you run into problems while using Parity Ethereum, feel free to file an issue in this repository or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
+If you run into problems while using Parity Ethereum, check out the [wiki for documentation](https://wiki.parity.io/), feel free to [file an issue in this repository](https://github.com/paritytech/parity-ethereum/issues/new), or hop on our [Gitter](https://gitter.im/paritytech/parity) or [Riot](https://riot.im/app/#/group/+parity:matrix.parity.io) chat room to ask a question. We are glad to help! **For security-critical issues**, please refer to the security policy outlined in [SECURITY.md](SECURITY.md).
Parity Ethereum's current beta-release is 2.0. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
## Build Dependencies
-Parity Ethereum requires Rust version 1.28.x to build.
+Parity Ethereum requires **Rust version 1.28.x** to build.
We recommend installing Rust through [rustup](https://www.rustup.rs/). If you don't already have `rustup`, you can install it like this:
@@ -117,8 +117,6 @@ or
$ git checkout beta
```
-first.
-
## Simple One-Line Installer for Mac and Linux
```bash
@@ -164,4 +162,6 @@ Alternatively, join our community on Matrix:
## Documentation
-Official website: https://parity.io | Be sure to check out [our wiki](https://wiki.parity.io) for more information.
+Official website: https://parity.io
+
+Be sure to [check out our wiki](https://wiki.parity.io) for more information.