Publish version 0.1.0 to NPM
authorNick Downing <nick@ndcode.org>
Tue, 27 Nov 2018 07:17:02 +0000 (18:17 +1100)
committerNick Downing <nick@ndcode.org>
Tue, 27 Nov 2018 07:17:23 +0000 (18:17 +1100)
README.md
package.json

index 4298482..a55a283 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@ An NDCODE project.
 
 ## Overview
 
-The `json_cache_rw` package exports a single constructor `JSONCacheRW(diag)`
-which must be called with the `new` operator. The resulting cache object stores 
+The `json_cache_rw` package exports a single constructor
+  `JSONCacheRW(diag)`
+which must be called with the `new` operator. The resulting cache object stores
 arbitrary node.js JSON objects, which are read from disk files and modified
 (repeatedly) during the execution of your program. The cache tracks the on-disk
 pathname of the object, and writes it back to there after a delay time. A
@@ -14,7 +15,7 @@ simple locking algorithm is implemented to support atomic modifications.
 ## Calling API
 
 Suppose one has a `JSONCacheRW` instance named `jcrw`. It behaves somewhat like
- an ES6 `Map` instance that maps pathname strings to JSON objects, except that
+an ES6 `Map` instance that maps pathname strings to JSON objects, except that
 it has `jcrw.read()`, `jcrw.write()`, and `jcrw.modify()` functions instead of
 `get` and `set`, and new objects are added to the cache by attempting to `read`
 them.
@@ -120,7 +121,7 @@ particular file or JSON object), so if an atomic modification must be carried
 out that involves several different JSON files, special precautions need to be
 taken. We will use an example of a money-transfer application with two files,
 `transactions.json` containing a log of transactions (an array that) and
-`balances.json` with account balances (a dictionary indexed by account number). 
+`balances.json` with account balances (a dictionary indexed by account number).
 
 To modify the transaction log consistently with the account balances in atomic
 fashion, both files should be locked by nesting the modifications. A consistent
@@ -265,9 +266,10 @@ All of our NPM packages are MIT licensed, please see LICENSE in the repository.
 
 ## Contributions
 
-We would greatly welcome your feedback and contributions. The `json_cache_rw`
-is under active development (and is part of a larger project that is also under
-development) and thus the API is considered tentative and subject to change. If
-this is undesirable, you could possibly pin the version in your `package.json`.
+The caching system is under active development (and is part of a larger project
+that is also under development) and thus the API is tentative. Please go ahead
+and incorporate the system into your project, or try out our example webserver
+built on the system, subject to the caution that the API could change. Please
+send us your experience and feedback, and let us know of improvements you make.
 
 Contact: Nick Downing <nick@ndcode.org>
index 9e77b04..b738588 100644 (file)
@@ -1,7 +1,7 @@
 {
   "name": "@ndcode/json_cache_rw",
-  "version": "0.1.1",
-  "description": "In-memory cache for node.js mutable JSON objects with delayed write.",
+  "version": "0.1.0",
+  "description": "In-memory cache for node.js mutable JSON objects with delayed write",
   "keywords": [
     "in-memory",
     "mutable",