mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
parent
83a7c04bce
commit
0bec20a1e3
33
README.md
33
README.md
@ -8,7 +8,7 @@ Or [Blockchain](https://en.wikipedia.org/wiki/Blockchain_(database)) for short.
|
|||||||
[](https://godoc.org/github.com/tendermint/tendermint)
|
)](https://godoc.org/github.com/tendermint/tendermint)
|
||||||
[](https://github.com/moovweb/gvm)
|
[](https://github.com/moovweb/gvm)
|
||||||
[](https://riot.im/app/#/room/#tendermint:matrix.org)
|
[](https://riot.im/app/#/room/#tendermint:matrix.org)
|
||||||
[](https://github.com/tendermint/tendermint/blob/master/LICENSE)
|
[](https://github.com/tendermint/tendermint/blob/master/LICENSE)
|
||||||
[](https://github.com/tendermint/tendermint)
|
[](https://github.com/tendermint/tendermint)
|
||||||
@ -30,7 +30,7 @@ While Tendermint is being used in production in private, permissioned
|
|||||||
environments, we are still working actively to harden and audit it in preparation
|
environments, we are still working actively to harden and audit it in preparation
|
||||||
for use in public blockchains, such as the [Cosmos Network](https://cosmos.network/).
|
for use in public blockchains, such as the [Cosmos Network](https://cosmos.network/).
|
||||||
We are also still making breaking changes to the protocol and the APIs.
|
We are also still making breaking changes to the protocol and the APIs.
|
||||||
Thus we tag the releases as *alpha software*.
|
Thus, we tag the releases as *alpha software*.
|
||||||
|
|
||||||
In any case, if you intend to run Tendermint in production,
|
In any case, if you intend to run Tendermint in production,
|
||||||
please [contact us](https://riot.im/app/#/room/#tendermint:matrix.org) :)
|
please [contact us](https://riot.im/app/#/room/#tendermint:matrix.org) :)
|
||||||
@ -46,7 +46,7 @@ For examples of the kinds of bugs we're looking for, see [SECURITY.md](SECURITY.
|
|||||||
|
|
||||||
Requirement|Notes
|
Requirement|Notes
|
||||||
---|---
|
---|---
|
||||||
Go version | Go1.9 or higher
|
Go version | Go1.10 or higher
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
@ -54,10 +54,10 @@ See the [install instructions](/docs/introduction/install.md)
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
- [Single node](/docs/using-tendermint.md)
|
- [Single node](/docs/tendermint-core/using-tendermint.md)
|
||||||
- [Local cluster using docker-compose](/networks/local)
|
- [Local cluster using docker-compose](/networks/local)
|
||||||
- [Remote cluster using terraform and ansible](/docs/networks/terraform-and-ansible.md)
|
- [Remote cluster using terraform and ansible](/docs/networks/terraform-and-ansible.md)
|
||||||
- [Join the public testnet](https://cosmos.network/testnet)
|
- [Join the Cosmos testnet](https://cosmos.network/testnet)
|
||||||
|
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
@ -66,30 +66,31 @@ See the [install instructions](/docs/introduction/install.md)
|
|||||||
For details about the blockchain data structures and the p2p protocols, see the
|
For details about the blockchain data structures and the p2p protocols, see the
|
||||||
the [Tendermint specification](/docs/spec).
|
the [Tendermint specification](/docs/spec).
|
||||||
|
|
||||||
For details on using the software, [Read The Docs](https://tendermint.readthedocs.io/en/master/).
|
For details on using the software, see the [documentation](/docs/) which is also
|
||||||
Additional information about some - and eventually all - of the sub-projects below, can be found at Read The Docs.
|
hosted at: https://tendermint.com/docs/
|
||||||
|
|
||||||
|
### Tools
|
||||||
|
|
||||||
|
Benchmarking and monitoring is provided by `tm-bench` and `tm-monitor`, respectively.
|
||||||
|
Their code is found [here](/tools) and these binaries need to be built seperately.
|
||||||
|
Additional documentation is found [here](/docs/tools).
|
||||||
|
|
||||||
### Sub-projects
|
### Sub-projects
|
||||||
|
|
||||||
* [Amino](http://github.com/tendermint/go-amino), a reflection-based improvement on proto3
|
* [Amino](http://github.com/tendermint/go-amino), a reflection-based improvement on proto3
|
||||||
* [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
|
* [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
|
||||||
|
|
||||||
### Tools
|
|
||||||
* [Deployment, Benchmarking, and Monitoring](http://tendermint.readthedocs.io/projects/tools/en/develop/index.html#tendermint-tools)
|
|
||||||
|
|
||||||
### Applications
|
### Applications
|
||||||
|
|
||||||
* [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
|
* [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
|
||||||
* [Ethermint](http://github.com/tendermint/ethermint); Ethereum on Tendermint
|
* [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
|
||||||
* [Many more](https://tendermint.readthedocs.io/en/master/ecosystem.html#abci-applications)
|
* [Many more](https://tendermint.com/ecosystem)
|
||||||
|
|
||||||
### More
|
### Research
|
||||||
|
|
||||||
* [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
|
* [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
|
||||||
* [Original Whitepaper](https://tendermint.com/static/docs/tendermint.pdf)
|
* [Original Whitepaper](https://tendermint.com/static/docs/tendermint.pdf)
|
||||||
* [Tendermint Blog](https://blog.cosmos.network/tendermint/home)
|
* [Blog](https://blog.cosmos.network/tendermint/home)
|
||||||
* [Cosmos Blog](https://blog.cosmos.network)
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
@ -130,6 +131,8 @@ data into the new chain.
|
|||||||
However, any bump in the PATCH version should be compatible with existing histories
|
However, any bump in the PATCH version should be compatible with existing histories
|
||||||
(if not please open an [issue](https://github.com/tendermint/tendermint/issues)).
|
(if not please open an [issue](https://github.com/tendermint/tendermint/issues)).
|
||||||
|
|
||||||
|
For more information on upgrading, see [here](./UPGRADING.md)
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
Please read, understand and adhere to our [code of conduct](CODE_OF_CONDUCT.md).
|
Please read, understand and adhere to our [code of conduct](CODE_OF_CONDUCT.md).
|
||||||
|
@ -5,7 +5,7 @@ is to run [this script](https://github.com/tendermint/tendermint/blob/develop/sc
|
|||||||
a fresh Ubuntu instance,
|
a fresh Ubuntu instance,
|
||||||
or [this script](https://github.com/tendermint/tendermint/blob/develop/scripts/install/install_tendermint_bsd.sh)
|
or [this script](https://github.com/tendermint/tendermint/blob/develop/scripts/install/install_tendermint_bsd.sh)
|
||||||
on a fresh FreeBSD instance. Read the comments / instructions carefully (i.e., reset your terminal after running the script,
|
on a fresh FreeBSD instance. Read the comments / instructions carefully (i.e., reset your terminal after running the script,
|
||||||
make sure your okay with the network connections being made).
|
make sure you are okay with the network connections being made).
|
||||||
|
|
||||||
## From Binary
|
## From Binary
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user