Merge pull request #73 from mnaamani/update-readme-and-changelog

README and CHANGELOG

CHANGELOG.md

@@ -1,8 +1,23 @@
+### Version 5.4.0 (Acropolis) - Athens testnet update 3 - June 22n 2019
+- New Forum - v1.0.0
+- Discovery Service to support new Storage Provider implementation.
+- Removing all previously uploaded content
+
+### Version 5.3.0 - Athens testnet update 2 - April 27th 2019
+- Fix to configure an onchain primary storage provider liason to work around incomplete storage server implementation.
+
+### Version 5.2.0 - Athens testnet update 1 - April 17th 2019
+- Fix account locking for staked roles to allow storage providers to submit transaction
+- Update substrate version to `6dfc3e8b057bb00322136251a0f10305fbb1ad8f` from v1 branch
+
+### Version 5.1.0 - Athens testnet release - April 14th 2019
+- Storage Role
+- Update to substrate version at `89bbb7b6d0e076f0eda736b330f5f792aa2e2991`
+
 ### Version 4 - Bug Fixes - March 4th 2019 - `9941dd`
  - Allow illiquid accounts to pay transaction fees. Fixes unstaking and setting memo, by permitting extrinsics which do not require more than a transaction fee to be accepted into mempool.
  - Updated Cargo dependencies to use forked substrate repo `github.com/joystream/substrate`
 
-
  On-chain runtime upgrade performed with sudo `consensus::setCode()`
 
 ### Version 3 - Sparta - March 1st 2019 - `1ca4cc`

README.md

@@ -12,21 +12,20 @@ The joystream runtime builds on [substrate v1.0](https://docs.substrate.dev/docs
 - [User membership system](src/membership/)
 - [Staked Roles](src/roles)
    - [Storage Provider](src/storage/)
-
-### Prerequisites
-
-To compile the runtime you will need some tools such as: Rust, llvm and openssl. You can install most of the dependencies with:
-
-```bash
-curl https://getsubstrate.io -sSf | bash
-```
+- [Forum](https://github.com/Joystream/substrate-forum-module)
+- [Discovery](src/discovery_service)
 
 ## Getting Started - Building the WASM runtime
 
 ```bash
+# Clone repository
 git clone https://github.com/Joystream/substrate-runtime-joystream
 cd substrate-runtime-joystream/
+
+# Install Pre-requisits
 ./setup.sh
+
+# Compile runtime
 ./build.sh
 ```
 
@@ -50,7 +49,7 @@ Deploying the compiled runtime on a live system can be done in one of two ways:
 cargo test
 ```
 
-### Coding style
+## Coding style
 
 We use `rustfmt` to format the source code for consistency.
 
@@ -66,13 +65,17 @@ Running rustfmt can be applied to all source files recursing subfolders:
 rustfmt src/*.*
 ```
 
+## Reproducible Builds
+
+In an attempt to have a reproducuble version of the runtime that can be verified independantly (by council members for example when deciding wether to vote in a runtime upgrade proposal) there is a `build-with-docker.sh` script which can be run to generate a `joystream_runtime.wasm` file to the current directory.
+
 ## Built With
 
 * [Substrate](https://github.com/paritytech/substrate)
 
 ## Contributing
 
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+Please see our [contributing guidlines](https://github.com/Joystream/joystream#contribute) for details on our code of conduct, and the process for submitting pull requests to us.
 
 ## Versioning