updated readme with 0.1.8 changes

Author: Joel Alejandro Villarreal Bertoldi

README.md

@@ -10,8 +10,6 @@ Simply run `npm install --save feathers-hooks-jsonapify` and you're good to go!
 
 ## Usage
 
-> **Important:** As of version 0.1.0, this hook is intended to use with Sequelize. Further versions will move the coupling code to hook configurations.
-
 This hook is intended to use with `feathers-rest`, since it'll convert that provider's response to a JSON-API compliant document.
 
 Require the hook:
@@ -46,9 +44,11 @@ app.hooks({
 
 ### Relationships
 
+*Available since: `v0.1.4`*
+
 `feathers-hooks-jsonapify` will automatically detect metadata for relationships in the model. It'll create an `included` top-level array in the document when the hook is called via `find`.
 
-> Currently working and tested with `belongsTo` and `hasMany` associations.
+> Currently working and tested with `belongsTo` and `hasMany` associations. This feature works only with a Sequelize adapter.
 
 #### Example document for a self-referencing model
 
@@ -95,6 +95,8 @@ app.hooks({
 
 ### Pagination
 
+*Available since: `v0.1.4`*
+
 The hook will also detect if `hook.result.skip`, `hook.result.limit` and `hook.result.total` are available as part of the `feathers-rest` provider. If available, it'll create `first`, `prev`, `next` and `last` links accordingly.
 
 The raw pagination data is moved to a `meta` object.
@@ -143,6 +145,112 @@ The raw pagination data is moved to a `meta` object.
 }
 ```
 
+## Plain Object Serialization (POS) :new:
+
+*Available since: `v0.1.8`*
+
+Common `Object` arrays can also be `jsonapified` for any custom service's `result`:
+
+### Multiple objects
+
+```js
+// Sample hook result, with multiple objects, from a `person` custom service.
+hook.result = [{
+  firstName: 'Joel',
+  lastName: 'Villarreal',
+  isEnabled: true
+}, {
+  firstName: 'Alejandro',
+  lastName: 'Bertoldi',
+  isEnabled: false
+}];
+```
+
+_JSONAPIfied_ result:
+
+```json
+{
+  "data": [
+    {
+      "id": "2f1faeefc0edc081b012113e08cd9960773a70eb4d16626fade328adb9be4477",
+      "type": "person",
+      "attributes": {
+        "first-name": "Joel",
+        "last-name": "Villarreal",
+        "isEnabled": true
+      },
+      "links": {
+        "self": "/person/2f1faeefc0edc081b012113e08cd9960773a70eb4d16626fade328adb9be4477"
+      }
+    },
+    {
+      "id": "5ad0e862ce3db03640bb696d1ca77a0905ef4400070549622e577c4001f3e96d",
+      "type": "person",
+      "attributes": {
+        "first-name": "Alejandro",
+        "last-name": "Bertoldi",
+        "isEnabled": false
+      },
+      "links": {
+        "self": "/person/5ad0e862ce3db03640bb696d1ca77a0905ef4400070549622e577c4001f3e96d"
+      }
+    }
+  ]
+}
+```
+
+### Single object
+
+```js
+// Sample hook result, with a single object in an array, from a `person` custom service.
+hook.result = [{
+  firstName: 'Joel',
+  lastName: 'Villarreal',
+  isEnabled: true
+}];
+
+// same as:
+hook.result = {
+  firstName: 'Joel',
+  lastName: 'Villarreal',
+  isEnabled: true
+};
+```
+
+_JSONAPIfied_ result:
+
+```json
+{
+  "data": {
+    "id": "2f1faeefc0edc081b012113e08cd9960773a70eb4d16626fade328adb9be4477",
+    "type": "person",
+    "attributes": {
+      "first-name": "Joel",
+      "last-name": "Villarreal",
+      "isEnabled": true
+    },
+    "links": {
+      "self": "/person/2f1faeefc0edc081b012113e08cd9960773a70eb4d16626fade328adb9be4477"
+    }
+  }
+}
+```
+
+### Identifier and type mapping
+
+The `jsonapify` hook receives an `options` object that accepts two settings for POS:
+
+- `identifierKey`: the name of the property to convert into `id`
+- `typeKey`: the name of the property to convert into `type`
+
+#### What happens if I don't use `identifierKey`?
+
+The hook's got your back. Using `crypto.createHash`, it creates a unique SHA-256 digest using the contents of the object.
+
+#### What happens if I don't use `typeKey`?
+
+The hook will use the service's name (`hook.service.options.name`) as each model's type.
+
 ## TODOs
 
 Check out the [issues](https://github.com/joelalejandro/feathers-hooks-jsonapify/issues).