diff --git a/README.md b/README.md index 1487351..c85e329 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -memstore Cluster -================ +Cluster Store +============= A very simple in-memory object store for use with node cluster (or even completely and unrelated node processes). @@ -29,7 +29,7 @@ you'll probably prefer to use this pattern: ```js var cluster = require('cluster'); -var store = require('memstore-cluster'); +var cstore = require('cluster-store'); var numCores = require('os').cpus().length; var opts = { @@ -46,7 +46,7 @@ var opts = { , standalone: (1 === numCores) // overrides serve and connect }; -memstore.create(opts).then(function (store) { +cstore.create(opts).then(function (store) { // same api as new sqlite3.Database(options.filename) store.get(id, function (err, data) { @@ -97,13 +97,13 @@ See @4.x for Standalone / Master Mode is in-process ======================== -The `master` in the cluster (meaning `opts.serve = true`) will directly hold the `express-session/session/memory` -memory store. +The `master` in the cluster (meaning `opts.serve = true`) will directly hold the specified store +(a simple memory store by default, or `express-session/session/memory` in the example above) Likewise, when only one process is being used (`opts.standalone = true`) the listener is not started and API is completely in-process. -If you take a look at `wrapper.js` you'll see that it's a rather simple memory store instance. +If you take a look at `memstore.js` you'll see that it's a rather simple memory store instance. Security Warning ================ diff --git a/package.json b/package.json index 9eaec96..4168391 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "memstore-cluster", + "name": "cluster-store", "version": "1.0.0", "description": "A wrapper to enable the use of a in-process store with node cluster via a socket server (i.e. for Raspberry Pi 2).", "main": "index.js", @@ -9,7 +9,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/coolaj86/memstore-cluster.git" + "url": "git+https://github.com/coolaj86/cluster-store.git" }, "keywords": [ "store", @@ -23,9 +23,9 @@ "author": "AJ ONeal (http://coolaj86.com/)", "license": "Apache-2.0", "bugs": { - "url": "https://github.com/coolaj86/memstore-cluster/issues" + "url": "https://github.com/coolaj86/cluster-store/issues" }, - "homepage": "https://github.com/coolaj86/memstore-cluster#readme", + "homepage": "https://github.com/coolaj86/cluster-store#readme", "dependencies": { "ws": "^0.7.2" }