Skip to content

Commit

Permalink
Refer to readthedocs for all documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jwolski committed Jul 29, 2015
1 parent b7f26ec commit a0fb944
Showing 1 changed file with 4 additions and 18 deletions.
22 changes: 4 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
# ringpop [![Build Status](https://travis-ci.org/uber/ringpop.svg?branch=master)] (https://travis-ci.org/uber/ringpop) [![Docs Status](https://readthedocs.org/projects/ringpop/badge/?version=latest)] (https://ringpop.readthedocs.org)
# ringpop
[![Build Status](https://travis-ci.org/uber/ringpop.svg?branch=master)] (https://travis-ci.org/uber/ringpop) [![Docs Status](https://readthedocs.org/projects/ringpop/badge/?version=latest)] (https://ringpop.readthedocs.org)

Ringpop is a library that brings cooperation and coordination to applications that would otherwise run as a set of independent worker processes.
Ringpop is a library that brings cooperation and coordination to distributed applications.

Ringpop implements a membership protocol that allows those workers to discover one another and use the communication channels established between them as a means of disseminating information, detecting failure and ultimately, converging on a consistent membership list. Consistent hashing is then applied on top of that list and gives an application the ability to define predictable behavior and data storage facilities within a custom keyspace. The keyspace is partitioned and evenly assigned to the individual instances of an application. Clients of the application remain simple and need not know of the underlying cooperation between workers nor chosen partitioning scheme. A request can be sent to any instance and Ringpop intelligently forwards the request to the "correct" instance as defined by a hash ring lookup.

With these 3 capabilities: membership protocol, consistent hashing and forwarding, Ringpop makes it possible to build extremely scalable and fault-tolerant distributed systems.

For more documentation, go to the [wiki](https://github.com/uber/ringpop/wiki).

# Installation

`npm install ringpop`

## Tests

`npm test`

# License
ringpop is available under the MIT license. See the LICENSE file for more info.
Interested? Read the docs at [ringpop.readthedocs.org](https://ringpop.readthedocs.org).

0 comments on commit a0fb944

Please sign in to comment.