You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

71 lines
3.8 KiB

10 years ago
8 years ago
8 years ago
8 years ago
10 years ago
9 years ago
9 years ago
8 years ago
8 years ago
9 years ago
9 years ago
9 years ago
9 years ago
8 years ago
10 years ago
9 years ago
8 years ago
9 years ago
9 years ago
8 years ago
  1. # Tendermint
  2. [Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance)
  3. [State Machine Replication](https://en.wikipedia.org/wiki/State_machine_replication).
  4. Or [Blockchain](https://en.wikipedia.org/wiki/Blockchain_(database)) for short.
  5. [![version](https://img.shields.io/github/tag/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/releases/latest)
  6. [![API Reference](
  7. https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667
  8. )](https://godoc.org/github.com/tendermint/tendermint)
  9. [![chat](https://img.shields.io/badge/slack-join%20chat-pink.svg)](http://forum.tendermint.com:3000/)
  10. [![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/blob/master/LICENSE)
  11. [![](https://tokei.rs/b1/github/tendermint/tendermint?category=lines)](https://github.com/tendermint/tendermint)
  12. Branch | Tests | Coverage | Report Card
  13. ----------|-------|----------|-------------
  14. 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)
  15. 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)
  16. _NOTE: This is alpha software. Please contact us if you intend to run it in production._
  17. Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine, written in any programming language,
  18. and securely replicates it on many machines.
  19. For more background, see the [introduction](https://tendermint.com/intro).
  20. To get started developing applications, see the [application developers guide](https://tendermint.com/docs/guides/app-development).
  21. ## Install
  22. To download pre-built binaries, see our [downloads page](https://tendermint.com/intro/getting-started/download).
  23. To install from source, you should be able to:
  24. `go get -u github.com/tendermint/tendermint/cmd/tendermint`
  25. For more details (or if it fails), see the [install guide](https://tendermint.com/docs/guides/install).
  26. ## Contributing
  27. Yay open source! Please see our [contributing guidelines](https://tendermint.com/docs/guides/contributing).
  28. ## Resources
  29. ### Tendermint Core
  30. - [Introduction](https://tendermint.com/intro)
  31. - [Docs](https://tendermint.com/docs)
  32. - [Software using Tendermint](https://tendermint.com/ecosystem)
  33. ### Sub-projects
  34. * [ABCI](http://github.com/tendermint/abci)
  35. * [Mintnet-kubernetes](https://github.com/tendermint/tools/tree/master/mintnet-kubernetes)
  36. * [Go-Wire](http://github.com/tendermint/go-wire)
  37. * [Go-P2P](http://github.com/tendermint/tendermint/p2p)
  38. * [Go-Merkle](http://github.com/tendermint/go-merkle)
  39. ### Applications
  40. * [Ethermint](http://github.com/tendermint/ethermint)
  41. * [Basecoin](http://github.com/tendermint/basecoin)
  42. ### More
  43. * [Tendermint Blog](https://tendermint.com/blog)
  44. * [Cosmos Blog](https://cosmos.network/blog)
  45. * [Original Whitepaper (out-of-date)](http://www.the-blockchain.com/docs/Tendermint%20Consensus%20without%20Mining.pdf)
  46. * [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)