2015-01-20 03:30:57 -08:00
|
|
|
# Tendermint
|
2016-03-03 16:54:23 -08:00
|
|
|
Simple, Secure, Scalable Blockchain Platform
|
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)
|
|
|
|
|
[](http://forum.tendermint.com:3000/)
|
|
|
|
|
[](https://github.com/tendermint/tendermint/blob/master/LICENSE)
|
|
|
|
|
|
|
|
|
|
Branch | Tests | Coverage | Report Card
|
|
|
|
|
----------|-------|----------|-------------
|
|
|
|
|
develop | [](https://circleci.com/gh/tendermint/tendermint/tree/develop) | [](https://codecov.io/gh/tendermint/tendermint) | [](https://goreportcard.com/report/github.com/tendermint/tendermint/tree/develop)
|
|
|
|
|
master | [](https://circleci.com/gh/tendermint/tendermint/tree/master) | [](https://codecov.io/gh/tendermint/tendermint) | [](https://goreportcard.com/report/github.com/tendermint/tendermint/tree/master)
|
2015-06-10 09:06:28 -07:00
|
|
|
|
2016-06-20 03:03:14 -07:00
|
|
|
_NOTE: This is yet pre-alpha non-production-quality software._
|
|
|
|
|
|
2016-08-06 20:37:21 -07:00
|
|
|
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine, written in any programming language,
|
|
|
|
|
and replicates it on many machines.
|
|
|
|
|
See the [application developers guide](https://github.com/tendermint/tendermint/wiki/Application-Developers) to get started.
|
2016-08-06 20:30:46 -07:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Yay open source! Please see our [contributing guidelines](https://github.com/tendermint/tendermint/wiki/Contributing).
|
|
|
|
|
|
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
|
|
|
|
2016-05-04 14:10:15 -07:00
|
|
|
- [Introduction](https://github.com/tendermint/tendermint/wiki/Introduction)
|
|
|
|
|
- [Validators](https://github.com/tendermint/tendermint/wiki/Validators)
|
|
|
|
|
- [Byzantine Consensus Algorithm](https://github.com/tendermint/tendermint/wiki/Byzantine-Consensus-Algorithm)
|
|
|
|
|
- [Block Structure](https://github.com/tendermint/tendermint/wiki/Block-Structure)
|
|
|
|
|
- [RPC](https://github.com/tendermint/tendermint/wiki/RPC)
|
|
|
|
|
- [Genesis](https://github.com/tendermint/tendermint/wiki/Genesis)
|
|
|
|
|
- [Configuration](https://github.com/tendermint/tendermint/wiki/Configuration)
|
|
|
|
|
- [Light Client Protocol](https://github.com/tendermint/tendermint/wiki/Light-Client-Protocol)
|
|
|
|
|
- [Roadmap for V2](https://github.com/tendermint/tendermint/wiki/Roadmap-for-V2)
|
2015-05-12 19:09:54 -07:00
|
|
|
|
2016-05-04 14:10:15 -07:00
|
|
|
### Sub-projects
|
|
|
|
|
|
|
|
|
|
* [TMSP](http://github.com/tendermint/tmsp)
|
|
|
|
|
* [Mintnet](http://github.com/tendermint/mintnet)
|
|
|
|
|
* [Go-Wire](http://github.com/tendermint/go-wire)
|
|
|
|
|
* [Go-P2P](http://github.com/tendermint/go-p2p)
|
|
|
|
|
* [Go-Merkle](http://github.com/tendermint/go-merkle)
|
2016-05-14 09:02:12 -07:00
|
|
|
|
2016-08-06 20:30:46 -07:00
|
|
|
## Install
|
2016-05-14 09:02:12 -07:00
|
|
|
|
2016-08-06 20:30:46 -07:00
|
|
|
`go get -u github.com/tendermint/tendermint/cmd/tendermint`
|
2016-05-16 08:16:53 -07:00
|
|
|
|
2016-08-06 20:30:46 -07:00
|
|
|
For more details, see the [install guide](https://github.com/tendermint/tendermint/wiki/Installation).
|
