2015-01-20 03:30:57 -08:00
# Tendermint
2016-12-08 21:26:19 -08:00
[Byzantine-Fault Tolerant ](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance )
2017-07-19 00:31:49 -07:00
[State Machine Replication ](https://en.wikipedia.org/wiki/State_machine_replication ).
2016-12-08 21:26:19 -08:00
Or [Blockchain ](https://en.wikipedia.org/wiki/Blockchain_(database )) for short.
2014-11-07 23:27:03 -08:00
2016-09-25 07:32:28 -07:00
[](https://github.com/tendermint/tendermint/releases/latest)
[](https://godoc.org/github.com/tendermint/tendermint)
2017-08-11 07:30:04 -07:00
[](https://cosmos.rocket.chat/)
2016-09-25 07:32:28 -07:00
[](https://github.com/tendermint/tendermint/blob/master/LICENSE)
2017-03-23 04:52:04 -07:00
[](https://github.com/tendermint/tendermint)
2016-09-25 07:32:28 -07:00
2017-09-18 13:23:22 -07:00
Branch | Tests |
----------|-------|
master | [](https://circleci.com/gh/tendermint/tendermint/tree/master)
develop | [](https://circleci.com/gh/tendermint/tendermint/tree/develop)
2015-06-10 09:06:28 -07:00
2017-04-18 20:14:10 -07:00
_NOTE: This is alpha software. Please contact us if you intend to run it in production._
2016-06-20 03:03:14 -07:00
2017-09-18 13:23:22 -07:00
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language -
2016-12-08 21:26:19 -08:00
and securely replicates it on many machines.
2017-09-18 13:23:22 -07:00
For more information, from introduction to install to application development, [Read The Docs ](http://tendermint.readthedocs.io/projects/tools/en/master/index.html ).
2017-06-19 06:46:15 -07:00
2016-12-08 21:26:19 -08:00
## Install
2017-07-19 00:31:49 -07:00
To download pre-built binaries, see our [downloads page ](https://tendermint.com/downloads ).
2017-01-29 13:38:54 -08:00
To install from source, you should be able to:
2016-12-08 21:26:19 -08:00
`go get -u github.com/tendermint/tendermint/cmd/tendermint`
2017-09-18 13:23:22 -07:00
For more details (or if it fails), [read the docs ](http://tendermint.readthedocs.io/projects/tools/en/master/install.html ).
2016-08-06 20:30:46 -07:00
2016-05-04 14:10:36 -07:00
## Resources
2016-05-04 14:01:51 -07:00
2016-05-04 14:10:15 -07:00
### Tendermint Core
2016-03-03 16:54:23 -08:00
2017-09-18 13:23:22 -07:00
All resources involving the use of, building application on, or developing for, tendermint, can be found at [Read The Docs ](http://tendermint.readthedocs.io/projects/tools/en/master/index.html ). Additional information about some - and eventually all - of the sub-projects below, can be found at Read The Docs.
2015-05-12 19:09:54 -07:00
2016-05-04 14:10:15 -07:00
### Sub-projects
2017-06-02 20:28:10 -07:00
* [ABCI ](http://github.com/tendermint/abci ), the Application Blockchain Interface
* [Go-Wire ](http://github.com/tendermint/go-wire ), a deterministic serialization library
2017-07-19 00:31:49 -07:00
* [Go-Crypto ](http://github.com/tendermint/go-crypto ), an elliptic curve cryptography library
2017-09-18 13:23:22 -07:00
* [TmLibs ](http://github.com/tendermint/tmlibs ), an assortment of Go libraries used internally
* [IAVL ](http://github.com/tendermint/iavl ), Merkleized IAVL+ Tree implementation
2017-06-02 20:18:10 -07:00
### Tools
2017-09-18 13:23:22 -07:00
* [Deployment, Benchmarking, and Monitoring ](http://tendermint.readthedocs.io/projects/tools/en/develop/index.html#tendermint-tools )
2016-05-14 09:02:12 -07:00
2016-12-12 11:12:13 -08:00
### Applications
2016-05-14 09:02:12 -07:00
2017-09-18 13:23:22 -07:00
* [Ethermint ](http://github.com/tendermint/ethermint ); Ethereum on Tendermint
* [Cosmos SDK ](http://github.com/cosmos/cosmos-sdk ); a cryptocurrency application framework
2016-12-12 11:12:13 -08:00
2017-07-19 00:31:49 -07:00
### More
2016-05-14 09:02:12 -07:00
2017-09-18 13:23:22 -07:00
* [Master's Thesis on Tendermint ](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769 )
* [Original Whitepaper ](https://tendermint.com/static/docs/tendermint.pdf )
2017-07-19 00:31:49 -07:00
* [Tendermint Blog ](https://blog.cosmos.network/tendermint/home )
* [Cosmos Blog ](https://blog.cosmos.network )
2017-09-18 13:23:22 -07:00
## Contributing
Yay open source! Please see our [contributing guidelines ](CONTRIBUTING.md ).
## Versioning
### SemVer
Tendermint uses [SemVer ](http://semver.org/ ) to determine when and how the version changes.
According to SemVer, anything in the public API can change at any time before version 1.0.0
To provide some stability to Tendermint users in these 0.X.X days, the MINOR version is used
to signal breaking changes across a subset of the total public API. This subset includes all
interfaces exposed to other processes (cli, rpc, p2p, etc.), as well as parts of the following packages:
- types
- rpc/client
- config
- node
Exported objects in these packages that are not covered by the versioning scheme
are explicitly marked by `// UNSTABLE` in their go doc comment and may change at any time.
Functions, types, and values in any other package may also change at any time.
### Upgrades
In an effort to avoid accumulating technical debt prior to 1.0.0,
we do not guarantee that breaking changes (ie. bumps in the MINOR version)
will work with existing tendermint blockchains. In these cases you will
have to start a new blockchain, or write something custom to get the old
data into the new chain.
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 )).
### Code of Conduct
Please read, understand and adhere to our [code of conduct ](CODE_OF_CONDUCT.md ).
