From 3f0f0d6ca6304a00d03cc99657bef483c7d845fb Mon Sep 17 00:00:00 2001 From: Bill Christo Date: Sat, 22 Oct 2016 13:02:45 -0400 Subject: [PATCH 1/3] Update README.md --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 45aa6d3..406f4bd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![NPM](https://nodei.co/npm/filejson.png?downloads=true&stars=true)](https://nodei.co/npm/filejson/) -Use a JSON encoded file to automatically save a JavaScript value to disk whenever that value changes. A value can be a Javascript: string, number, boolean, null, object, or an array. The value can be structured in an array or an object to allow for more complex data stores. These structures can also be nested. As a result, you can use this module as a simple document store for storing semi structured data. +Seamlessl sync a JavaScript value to a JSON encoded file automatically in the background whenever that value changes. A value can be a Javascript: string, number, boolean, null, object, or an array. The value can be structured in an array or an object to allow for more complex data stores. These structures can also be nested. As a result, you can use this module as a simple document store for storing semi structured data. ## Requirements [ECMAScript 6 Reflect and Proxy objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) support, which is found natively in Node.js >= 6. If you are using a version of Node.js < 6, use a polyfill, such as [harmony-reflect](https://github.com/tvcutsem/harmony-reflect). Proxy support is key for this module working so eloquently. Other non-Proxy based modules require function calls each time you wish to save an object. Unlike those, [filejson](https://github.com/bchr02/filejson) is as easy as ```file.contents = "my new value"``` or ```file.contents = {"msg": "Hello World"}``` and the changes are automatically saved to disk. @@ -12,21 +12,7 @@ Use a JSON encoded file to automatically save a JavaScript value to disk wheneve ```javascript npm install filejson --save ``` - -## Additional installation and usage steps for those using Node.js 5 or earlier - -* You will need a polyfill such as [harmony-reflect](https://github.com/tvcutsem/harmony-reflect): -``` -npm install harmony-reflect --save -``` -* In addition to requiring filejson, you will need to require harmony-reflect at the top of your app, like this: -```javascript -var Reflect = require('harmony-reflect'); -``` -* Lastly, every time you run your app you will need to use the node --harmony_proxies flag, like this: -``` -node --harmony_proxies index.js -``` +[If you are using Node.js 5 or earlier, some additional installation and usage steps are needed. Click here.](#additional-installation-and-usage-steps-for-those-using-nodejs-5-or-earlier) ## Example usage ```javascript @@ -49,3 +35,18 @@ function proceed(error, file) { } ``` + +## Additional installation and usage steps for those using Node.js 5 or earlier + +* You will need a polyfill such as [harmony-reflect](https://github.com/tvcutsem/harmony-reflect): +``` +npm install harmony-reflect --save +``` +* In addition to requiring filejson, you will need to require harmony-reflect at the top of your app, like this: +```javascript +var Reflect = require('harmony-reflect'); +``` +* Lastly, every time you run your app you will need to use the node --harmony_proxies flag, like this: +``` +node --harmony_proxies index.js +``` From c0996e1c6935b1398bd2d7f0e73e41b08457c1a4 Mon Sep 17 00:00:00 2001 From: Bill Christo Date: Sat, 22 Oct 2016 13:03:16 -0400 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 406f4bd..67ad5d2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![NPM](https://nodei.co/npm/filejson.png?downloads=true&stars=true)](https://nodei.co/npm/filejson/) -Seamlessl sync a JavaScript value to a JSON encoded file automatically in the background whenever that value changes. A value can be a Javascript: string, number, boolean, null, object, or an array. The value can be structured in an array or an object to allow for more complex data stores. These structures can also be nested. As a result, you can use this module as a simple document store for storing semi structured data. +Seamlessly sync a JavaScript value to a JSON encoded file automatically in the background whenever that value changes. A value can be a Javascript: string, number, boolean, null, object, or an array. The value can be structured in an array or an object to allow for more complex data stores. These structures can also be nested. As a result, you can use this module as a simple document store for storing semi structured data. ## Requirements [ECMAScript 6 Reflect and Proxy objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) support, which is found natively in Node.js >= 6. If you are using a version of Node.js < 6, use a polyfill, such as [harmony-reflect](https://github.com/tvcutsem/harmony-reflect). Proxy support is key for this module working so eloquently. Other non-Proxy based modules require function calls each time you wish to save an object. Unlike those, [filejson](https://github.com/bchr02/filejson) is as easy as ```file.contents = "my new value"``` or ```file.contents = {"msg": "Hello World"}``` and the changes are automatically saved to disk. From 2ba50dbd2a136ae7b565f34ca6ff709c747d5929 Mon Sep 17 00:00:00 2001 From: Bill Christo Date: Sat, 22 Oct 2016 13:07:34 -0400 Subject: [PATCH 3/3] Update package.json --- package.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 3c0f3f8..cc7a928 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "filejson", - "version": "1.0.9", - "description": "Use a JSON encoded file to automatically save a JavaScript value to disk whenever that value changes.", + "version": "1.0.10", + "description": "Seamlessly syncs a JavaScript value to a JSON file in the background whenever that value changes.", "main": "app.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" @@ -9,7 +9,7 @@ "author": "Bill Christo", "license": "MIT", "devDependencies": { - "eslint": "^3.7.1" + "eslint": "^3.8.1" }, "dependencies": {}, "bugs": { @@ -33,6 +33,9 @@ "document-store", "document", "noSQL", + "ORM", + "RDBMS", + "ODBMS", "Semi-structured", "structured", "structured-data",