forked from hyperledger-iroha/iroha-dco
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change README.md file (hyperledger-iroha#1163)
* Change version and review date Signed-off-by: neewy <[email protected]> * Update readme Signed-off-by: neewy <[email protected]> * Delete all Signed-off-by: neewy <[email protected]>
- Loading branch information
1 parent
31c7a7f
commit 05da898
Showing
3 changed files
with
11 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,6 +11,8 @@ | |
|
||
Blockchain platform Hyperledger Iroha is designed for simple creation and management of assets. This is a distributed ledger of transactions. | ||
|
||
Check [overview](http://iroha.readthedocs.io/en/latest/overview/) page of our documentation. | ||
|
||
<img height="300px" src="docs/image_assets/Iroha_3_sm.png" | ||
alt="Iroha logo" title="Iroha" align="right" /> | ||
|
||
|
@@ -23,45 +25,23 @@ Iroha has the following features: | |
|
||
Among the non-functional requirements can be noted a high degree of network fault tolerance _(Byzantine Fault Tolerant)_. | ||
|
||
## 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 | ||
|
||
Please, follow [build process](https://hyperledger.github.io/iroha-api/#build). | ||
After building Iroha daemon, try to use [CLI](https://hyperledger.github.io/iroha-api/#command-line-interface) or launch Iroha [peer network](https://soramitsu.atlassian.net/wiki/spaces/IS/pages/12517377/Create+swarm+network+of+Iroha+nodes). | ||
## Documentation | ||
|
||
Check [getting started](http://iroha.readthedocs.io/en/latest/getting_started/) section in your version of localized docs to start exploring the system. | ||
|
||
## Find out more | ||
|
||
| Technical docs | Guides | Contributing | | ||
|---|---|---| | ||
|[![Technical docs](docs/image_assets/icons/docs.png)](https://hyperledger.github.io/iroha-api)| [![How-to](docs/image_assets/icons/how-to.png)](https://github.com/hyperledger/iroha/wiki) |[![Contributing](docs/image_assets/icons/contributing.png)](https://github.com/hyperledger/iroha/wiki/How-to-contribute)| | ||
For more information, such as how to use client libraries in your target programming language, or how to deploy Iroha in a network check the rest of the documentation. | ||
|
||
## Need help? | ||
|
||
* Join [telegram chat](https://t.me/joinchat/AgzrTUCZ6edlj6V612n5JQ) where the maintainers team is able to help you | ||
* 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) | ||
* Submit issues via GitHub Iroha repository | ||
* 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) | ||
|
||
|
||
## License | ||
|
||
Copyright 2016, 2017 Soramitsu Co., Ltd. | ||
Copyright 2016 – 2018 Soramitsu Co., Ltd. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters