📔 Documentation update

Author: dr-dimitru

README.md

@@ -1,9 +1,11 @@
-# Persistent Client (Browser) Storage
-
-<a href="https://www.patreon.com/bePatron?u=20396046">
-  <img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
+[![support](https://img.shields.io/badge/support-GitHub-white)](https://github.com/sponsors/dr-dimitru)
+[![support](https://img.shields.io/badge/support-PayPal-white)](https://paypal.me/veliovgroup)
+<a href="https://ostr.io/info/built-by-developers-for-developers">
+  <img src="https://ostr.io/apple-touch-icon-60x60.png" height="20">
 </a>
 
+# Persistent Browser (Client) Storage
+
 - 👷 __100% Tests coverage__;
 - 📦 No external dependencies;
 - 💪 Bulletproof persistent Client storage;
@@ -35,85 +37,98 @@ meteor npm install --save ClientStorage
 
 ```js
 var ClientStorage = require('ClientStorage').ClientStorage;
+var clientStorage = new ClientStorage();
+```
+
+### ES6 Import:
+
+```js
+import { ClientStorage } from 'ClientStorage';
+const clientStorage = new ClientStorage();
 ```
 
 ### ES6 Import (Meteor):
 
 ```js
 import { ClientStorage } from 'meteor/ostrio:cstorage';
+const clientStorage = new ClientStorage();
 ```
 
 ## Usage:
 
-- `ClientStorage.get('key')` - Read a record. If the key doesn't exist a *undefined* value will be returned;
+- `clientStorage.get('key')` - Read a record. If the key doesn't exist a *undefined* value will be returned;
   - `key` - {*String*} - Record's key;
-- `ClientStorage.set('key', value[, ttl])` - Create/overwrite a value in storage;
+- `clientStorage.set('key', value[, ttl])` - Create/overwrite a value in storage;
   - `key` - {*String*} - Record's key;
   - `value` - {*String*|[*mix*]|*Boolean*|*Object*} - Record's value (content);
   - `ttl` - {*Number*} — [Optional] Record's TTL in seconds;
-- `ClientStorage.remove('key')` - Remove a record;
+- `clientStorage.remove('key')` - Remove a record;
   - `key` - {*String*} - Record's key;
-- `ClientStorage.has('key')` - Check whether a record exists, returns a boolean value;
+- `clientStorage.has('key')` - Check whether a record exists, returns a boolean value;
   - `key` - {*String*} - Record's key;
-- `ClientStorage.keys()` - Returns an array of all storage keys;
-- `ClientStorage.empty()` - Empty storage (remove all key/value pairs). __Use with caution! (*May remove cookies which weren't set by you*)__.
+- `clientStorage.keys()` - Returns an array of all storage keys;
+- `clientStorage.empty()` - Empty storage (remove all key/value pairs). __Use with caution! (*May remove cookies which weren't set by you*)__.
 
 ## Alternate usage:
 
-### Use `cookies` only:
+By default ClientStorage package handle selecting storage driver in the next order (descending priority):
 
-To use `cookies` as a driver for `ClientStorage` create new instance of `clientStorage` (*camel-case, first letter __lower-case__*):
+1. `localStorage`
+2. `cookies`
+3. `js` (*JS Object driven storage*)
 
-```js
-var clientStorage  = require('ClientStorage').clientStorage;
-var csCookies = new clientStorage('cookies');
-csCookies.has('locale'); // false
-csCookies.set('locale', 'en_US'); // true
-```
+To alter priority pass "preferred driver" to `new ClientStorage(driverName)` constructor.
+
+### Use `cookies` only:
 
-or in ES6 (Meteor):
+Pass `cookies` as an argument to new instance of `ClientStorage`:
 
 ```js
-import { clientStorage } from 'meteor/ostrio:cstorage';
-const csLocalStorage = new clientStorage('cookies');
-csLocalStorage.has('locale'); // false
-csLocalStorage.set('locale', 'en_US'); // true
+const { clientStorage } = require('ClientStorage');
+var cookiesStorage = new ClientStorage('cookies');
+cookiesStorage.has('locale'); // false
+cookiesStorage.set('locale', 'en_US'); // true
 ```
 
 ### Use `localStorage` only:
 
-To use `localStorage` as a driver for `ClientStorage` create new instance of `clientStorage` (*camel-case, first letter __lower-case__*):
+Pass `localStorage` as an argument to new instance of `ClientStorage`:
 
 ```js
-var clientStorage  = require('ClientStorage').clientStorage;
-var csLocalStorage = new clientStorage('localStorage');
-csLocalStorage.has('locale'); // false
-csLocalStorage.set('locale', 'en_US'); // true
+const { clientStorage } = require('ClientStorage');
+var locStorage = new ClientStorage('localStorage');
+locStorage.has('locale'); // false
+locStorage.set('locale', 'en_US'); // true
 ```
 
-or in ES6 (Meteor):
+### Use `js` only:
+
+Pass `js` (*in-memory js object*) as an argument to new instance of `ClientStorage`:
 
 ```js
-import { clientStorage } from 'meteor/ostrio:cstorage';
-const csLocalStorage = new clientStorage('localStorage');
-csLocalStorage.has('locale'); // false
-csLocalStorage.set('locale', 'en_US'); // true
+const { clientStorage } = require('ClientStorage');
+var jsStorage = new ClientStorage('js');
+jsStorage.has('locale'); // false
+jsStorage.set('locale', 'en_US'); // true
 ```
 
 __Note:__ *All instances are sharing same cookie and localStorage records!*
 
 ## [Meteor] Add reactivity:
 
+Persistent `ReactiveVar` implementation:
+
 ```js
-import { ReactiveVar }   from 'meteor/reactive-var';
+import { ReactiveVar } from 'meteor/reactive-var';
 import { ClientStorage } from 'meteor/ostrio:cstorage';
+const clientStorage = new ClientStorage();
 
-const persistentReactive = (name, initial = false) => {
+const persistentReactive = (name, initial = undefined) => {
   let reactive;
-  if (ClientStorage.has(name)) {
-    reactive = new ReactiveVar(ClientStorage.get(name));
+  if (clientStorage.has(name)) {
+    reactive = new ReactiveVar(clientStorage.get(name));
   } else {
-    ClientStorage.set(name, initial);
+    clientStorage.set(name, initial);
     reactive = new ReactiveVar(initial);
   }
 
@@ -123,43 +138,43 @@ const persistentReactive = (name, initial = false) => {
       return;
     }
     reactive.curValue = newValue;
-    ClientStorage.set(name, newValue);
+    clientStorage.set(name, newValue);
     reactive.dep.changed();
   };
 
   return reactive;
 };
 
-const UILayout = persistentReactive('UILayout', 'two-columns');
-UILayout.get(); // two-columns
-UILayout.set('single-column');
+const layout = persistentReactive('ui-layout', 'two-columns');
+layout.get(); // two-columns
+layout.set('single-column');
 ```
 
 ## Examples:
 
 ```js
-var ClientStorage = require('ClientStorage').ClientStorage;
+const clientStorage = new (require('ClientStorage').ClientStorage);
 
-ClientStorage.set('locale', 'en'); // true
-ClientStorage.set('country', 'usa'); // true
-ClientStorage.set('gender', 'male'); // true
+clientStorage.set('locale', 'en'); // true
+clientStorage.set('country', 'usa'); // true
+clientStorage.set('gender', 'male'); // true
 
-ClientStorage.get('gender'); // male
+clientStorage.get('gender'); // male
 
-ClientStorage.has('locale'); // true
-ClientStorage.has('city'); // false
+clientStorage.has('locale'); // true
+clientStorage.has('city'); // false
 
-ClientStorage.keys(); // ['locale', 'country', 'gender']
+clientStorage.keys(); // ['locale', 'country', 'gender']
 
-ClientStorage.remove('locale'); // true
-ClientStorage.get('locale'); // undefined
+clientStorage.remove('locale'); // true
+clientStorage.get('locale'); // undefined
 
-ClientStorage.keys(); // ['country', 'gender']
+clientStorage.keys(); // ['country', 'gender']
 
-ClientStorage.empty(); // true
-ClientStorage.keys(); // []
+clientStorage.empty(); // true
+clientStorage.keys(); // []
 
-ClientStorage.empty(); // false
+clientStorage.empty(); // false
 ```
 
 ## Running Tests
@@ -183,5 +198,6 @@ MONGO_URL="mongodb://127.0.0.1:27017/client-storage-tests" meteor test-packages
 
 ## Support this project:
 
-- [Become a patron](https://www.patreon.com/bePatron?u=20396046) — support my open source contributions with monthly donation
+- [Sponsor via GitHub](https://github.com/sponsors/dr-dimitru)
+- [Support via PayPal](https://paypal.me/veliovgroup)
 - Use [ostr.io](https://ostr.io) — [Monitoring](https://snmp-monitoring.com), [Analytics](https://ostr.io/info/web-analytics), [WebSec](https://domain-protection.info), [Web-CRON](https://web-cron.info) and [Pre-rendering](https://prerendering.com) for a website