Merge pull request hyperledger-iroha#492 from hyperledger/feature/docs

Updated readme file

MAINTAINERS.md

@@ -10,3 +10,10 @@
 | Hiroshi Sasagawa | SasagawaHiroshi | [email protected] |
 | Takumi Yamashita | satelliteyes | [email protected] |
 | Bogdan Vaneev | Warchant | [email protected] |
+| Fyodor Muratov | muratovv | [email protected] |
+| Andrei Lebedev | lebron | [email protected] |
+| Bulat Nasrulin | lebron | [email protected] |
+| Kamil Salakhiev | kamilsa | [email protected] |
+| Konstantin Munichev | luckychess | [email protected] |
+| Evgenii Mininbaev | l4l | [email protected] |
+| Nikolay Yushkevich | neewy | [email protected] |

README.md

@@ -1,34 +1,87 @@
-# いろは(iroha)
-[![Join the chat at https://gitter.im/hyperledger-iroha/Lobby](https://badges.gitter.im/hyperledger-iroha/Lobby.svg)](https://gitter.im/hyperledger-iroha/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# What is Hyperledger Iroha?
 
-[![CircleCI](https://circleci.com/gh/hyperledger/iroha/tree/master.svg?style=svg)](https://circleci.com/gh/hyperledger/iroha/tree/master)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/960/badge)](https://bestpractices.coreinfrastructure.org/projects/960)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/4d8edb74d4954c76a4656a9e109dbc4e)](https://www.codacy.com/app/neewy/iroha?utm_source=github.com&utm_medium=referral&utm_content=hyperledger/iroha&utm_campaign=Badge_Grade)
+[![CircleCI](https://circleci.com/gh/hyperledger/iroha/tree/master.svg?style=svg)](https://circleci.com/gh/hyperledger/iroha/tree/master)
+
+Blockchain platform Hyperledger Iroha is designed for simple creation and management of assets. This is a distributed ledger of transactions.
+
+<img height="300px" src="docs/Iroha_3_sm.png"
+ alt="Iroha logo" title="Iroha" align="right" />
+
+Iroha has the following features:
+1. Creation and management of custom complex assets, such as currencies or indivisible rights, serial numbers, patents, etc.
+2. Management of user accounts
+3. Taxonomy of accounts based on _domains_ — or _sub-ledgers_ in the system
+4. The system of rights and verification of user permissions for the execution of transactions and queries in the system
+5. Validation of business rules for transactions and queries in the system
+
+Among the non-functional requirements can be noted a high degree of network fault tolerance _(Byzantine Fault Tolerant)_.
+
+## Current Status
+
+Iroha v0.95 preview version is released on [TBD].
+
+## Iroha repository 101
+
+Iroha runs as a daemon _(irohad)_, representing a single peer in the Iroha network. For each peer, there is the following package structure, corresponding to components in the system:
+
+* *Torii* (⛩, gate) is a package that contains classes, which are in charge of interaction with users (clients)
+* *Network* encompasses interaction with the network of peers
+* *Validation* classes check business rules and validity (correct format) of transactions or queries
+* *Synchronizer* helps to synchronize new peers in the system or temporarily disconnected peers
+* *Simulator* generates a temporary snapshot of storage to validate transactions
+* *Ametsuchi* is the ledger block storage
+* *Model* classes are system entities, and converters for them
+
+<br>
+
+For other components and more explanations, please take a look at the *technical and design docs.*
+
+## Quickstart
+
+### Docker
+
+You may use the docker ennvironment to build and run the system, by executing the following:
+
+```
+git clone https://github.com/hyperledger/iroha.git
+sh iroha/docker/run-ametsuchi-dev.sh
+```
+
+After that, the container will run in interactive mode. So, you can run any IDE or editor on your local environment, while building the system in docker environment
+
+### Build
+
+To build the system, execute the the following:
 
-Please see the [**wiki**](https://github.com/hyperledger/iroha/wiki) for information about developing for Iroha and explanation of our algorithms.
+```
+cmake -H. -Bbuild; cmake --build build -- -j4;
+```
 
-いろは (Iroha) is a simple, distributed ledger.
+Consider executing ``` git clean -ix``` and choosing the `c` option when you want to rebuild the system (to clean up generated protobuf code).
+Also, use the `--clean-first` flag for rebuild.
 
-![alt tag](docs/Iroha_3_sm.png)
+### Test
 
-# Current Status
+`[TBD]`.
 
-Currently Hyperledger Iroha is in development, with an estimate v0.95 beta release in mid July. The current version is undergoing significant changes and it is likely there will be problems with use! Please use the *develop* branch. If you have any issues or questions, please [open an issue](https://github.com/hyperledger/iroha/issues).
+## Find out more
 
-# Pull Requests
-Please include a developer certificate with pull requests: https://www.clahub.com/agreements/hyperledger/iroha
+| Technical docs | Guides | Contributing |
+|---|---|---|
+|[![Technical docs](docs/icons/docs.png)](http://google.com/)| [![How-to](docs/icons/how-to.png)](http://google.com/) |[![Contributing](docs/icons/contributing.png)](http://google.com/)|
 
-# Documentation
- - [Architecture](./docs/architecture.md)
- - [Build iroha in local environment](./docs/how_to_build.rst)
- - [Using docker to build iroha container](./docker/README.md)
- - [Deploying a network of N nodes](./docs/iroha_network.md)
+## Need help?
 
-# Authors
+* Join [HyperLedger RocketChat](https://chat.hyperledger.org) #iroha channel to discuss your concerns and proposals
+* Use mailing list to spread your word within Iroha development community [[email protected]](mailto:[email protected])
+* Submit issues via GitHub Iroha repository
+* Communicate in Gitter chat with our development community [![Join the chat at https://gitter.im/hyperledger-iroha/Lobby](https://badges.gitter.im/hyperledger-iroha/Lobby.svg)](https://gitter.im/hyperledger-iroha/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-[MakotoTakemiya](https://github.com/takemiyamakoto)  
-[MizukiSonoko](https://github.com/MizukiSonoko)
 
-# License
+## License
 
 Copyright 2016, 2017 Soramitsu Co., Ltd.