Skip to content
Browse files

edit README

  • Loading branch information...
1 parent a8dfe9c commit 96653593bf302b7894908b09ada3ae6f5506bcff @dakatsuka committed
Showing with 45 additions and 3 deletions.
  1. +45 −3 README.md
View
48 README.md
@@ -1,7 +1,49 @@
# node-consistent-hashing
-This module is Consistent Hashing for Node.js
+A pure JavaScript implementation of Consistent Hashing for Node.js.
-## About
+## Installation
-A pure JavaScript implementation of Consistent Hashing for Node.js.
+ npm install consistent-hashing
+
+## Usage
+
+ var ConsistentHashing = require('consistent-hashing');
+ var cons = new ConsistentHashing(["node1", "node2", "node3"]);
+
+ var nodes = {};
+ var chars = [
+ 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I',
+ 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R',
+ 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'
+ ];
+
+ chars.forEach(function(c) {
+ var node = cons.getNode(c);
+
+ if (nodes[node]) {
+ nodes[node].push(c);
+ } else {
+ nodes[node] = [];
+ nodes[node].push(c);
+ }
+ });
+
+ console.log(nodes);
+
+ // { node3: [ 'A', 'F', 'H', 'J', 'N', 'S', 'U', 'W', 'X' ],
+ // node1: [ 'B', 'C', 'E', 'G', 'L', 'M', 'Q', 'R', 'V', 'Y', 'Z' ],
+ // node2: [ 'D', 'I', 'K', 'O', 'P', 'T' ] }
+
+add nodes:
+
+ cons.addNode("node4");
+
+remove node:
+
+ cons.removeNode("node1");
+
+
+## Copyright
+
+Copyright (C) 2011 Dai Akatsuka, released under the MIT License.

0 comments on commit 9665359

Please sign in to comment.
Something went wrong with that request. Please try again.