tendermint/README.md

47 lines
2.0 KiB
Markdown
Raw Normal View History

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-06-16 19:24:23 -04:00
[![CircleCI](https://circleci.com/gh/tendermint/tendermint.svg?style=svg)](https://circleci.com/gh/tendermint/tendermint)
2016-07-23 12:48:30 -04:00
[![codecov](https://codecov.io/gh/tendermint/tendermint/branch/develop/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint)
2015-06-10 12:06:28 -04:00
2016-06-20 03:03:14 -07:00
_NOTE: This is yet pre-alpha non-production-quality software._
## App Developers
Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes an application, written in any programming language,
and replicates it (ie. the latest state) on many machines.
See the [application developers guide](guide://github.com/tendermint/tendermint/wiki/Application-Developers) to get started.
## 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 12:02:12 -04:00
*
## Install
2016-05-14 12:02:12 -04:00
`go get -u github.com/tendermint/tendermint/cmd/tendermint`
2016-05-16 11:16:53 -04:00
For more details, see the [install guide](https://github.com/tendermint/tendermint/wiki/Installation).