tendermint/README.md

78 lines
4.2 KiB
Markdown
Raw Normal View History

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)
[State Machine Replication](https://en.wikipedia.org/wiki/State_machine_replication).
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
[![version](https://img.shields.io/github/tag/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/releases/latest)
[![API Reference](
https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
)](https://godoc.org/github.com/tendermint/tendermint)
[![chat](https://img.shields.io/badge/slack-join%20chat-pink.svg)](http://forum.tendermint.com:3000/)
[![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/blob/master/LICENSE)
2017-03-23 04:52:04 -07:00
[![](https://tokei.rs/b1/github/tendermint/tendermint?category=lines)](https://github.com/tendermint/tendermint)
2016-09-25 07:32:28 -07:00
Branch | Tests | Coverage | Report Card
----------|-------|----------|-------------
develop | [![CircleCI](https://circleci.com/gh/tendermint/tendermint/tree/develop.svg?style=shield)](https://circleci.com/gh/tendermint/tendermint/tree/develop) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/develop/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint) | [![Go Report Card](https://goreportcard.com/badge/github.com/tendermint/tendermint/tree/develop)](https://goreportcard.com/report/github.com/tendermint/tendermint/tree/develop)
master | [![CircleCI](https://circleci.com/gh/tendermint/tendermint/tree/master.svg?style=shield)](https://circleci.com/gh/tendermint/tendermint/tree/master) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint) | [![Go Report Card](https://goreportcard.com/badge/github.com/tendermint/tendermint/tree/master)](https://goreportcard.com/report/github.com/tendermint/tendermint/tree/master)
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
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,
2016-12-08 21:26:19 -08:00
and securely replicates it on many machines.
For more background, see the [introduction](https://tendermint.com/intro).
To get started developing applications, see the [application developers guide](https://tendermint.com/docs/guides/app-development).
2017-06-19 06:46:15 -07:00
### Code of Conduct
Please read, understand and adhere to our [code of conduct](CODE_OF_CONDUCT.md).
2016-12-08 21:26:19 -08:00
## Install
2017-01-29 13:38:54 -08:00
To download pre-built binaries, see our [downloads page](https://tendermint.com/intro/getting-started/download).
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-01-29 13:38:54 -08:00
For more details (or if it fails), see the [install guide](https://tendermint.com/docs/guides/install).
## Contributing
Yay open source! Please see our [contributing guidelines](https://tendermint.com/docs/guides/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-12-08 21:26:19 -08:00
- [Introduction](https://tendermint.com/intro)
- [Docs](https://tendermint.com/docs)
- [Software using Tendermint](https://tendermint.com/ecosystem)
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
* [Go-Crypto](http://github.com/tendermint/go-crypto), an elliptic curve cryptography library
* [TmLibs](http://github.com/tendermint/tmlibs), an assortment of Go libraries
* [Merkleeyes](http://github.com/tendermint/merkleeyes), a balanced, binary Merkle tree for ABCI apps
2017-06-02 20:18:10 -07:00
### Tools
* [Deployment, Benchmarking, and Monitoring](https://github.com/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-06-02 20:28:10 -07:00
* [Ethermint](http://github.com/tendermint/ethermint): Ethereum on Tendermint
* [Basecoin](http://github.com/tendermint/basecoin), a cryptocurrency application framework
2016-12-12 11:12:13 -08:00
### More
2016-05-14 09:02:12 -07:00
2016-12-08 21:26:19 -08:00
* [Tendermint Blog](https://tendermint.com/blog)
* [Cosmos Blog](https://cosmos.network/blog)
* [Original Whitepaper (out-of-date)](http://www.the-blockchain.com/docs/Tendermint%20Consensus%20without%20Mining.pdf)
* [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
2016-05-16 08:16:53 -07:00