hsdk - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

package.json

 {
   "name": "hsdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "A hypermedia standard development kit for knowing about home api endpoints",
@@ -5,0 +5,0 @@ "main": "transpiled/source/index.js",

README.md

@@ -16,11 +16,57 @@ # hsdk
 
+First you need to define your core sdk:
+
 ``` javascript
 import hsdk from "hsdk"
 
-hsdk({home: "http://hsdkjs.getsandbox.com/v1/resources"})
+const sdk = hsdk({home: "https://hsdkjs.getsandbox.com/v1/resources"})
+```
+
+`sdk` above is a `Promise` based on a request/response to/from the home resource.
+
+Now we can start making requests to our api, discovered 🌟magically🌟:
+
+``` javascript
+sdk
   .then((client) => client.accounts.v1.list())
-  .then((value) => console.log(value))
+  .then((response) => console.log({message: "List", payload: response.data}))
 ```
 
+That will `log` a list of accounts.
 
+``` javascript
+sdk
+  .then((client) => client.accounts.v1.show({id: "1"}))
+  .then((response) => console.log({message: "Show", payload: response.data}))
+```
+
+This will `log` a single account, with the `id` of `1`
+
+``` javascript
+sdk
+  .then((client) => {
+    return client
+      .accounts
+      .v1
+      .update({
+        id: "1",
+        payload: {
+          data: {
+            id: "1",
+            type: "accounts",
+            attributes: {
+              age: 29
+            }
+          }
+        }
+      })
+  })
+  .then((response) => console.log({message: "Update", payload: response.data}))
+```
+
+In `POST`, `PATCH`, or `PUT` requests (mutations) `hsdk` expects a `payload` value that it uses in the body. This `update` request will update the age of `accounts/1` to `29`.
+
+hsdk doesn't care what kind of API you have, only that it is discoverable via `jsonapi-home`.
+
+
 ## jsonapi-home
@@ -27,0 +73,0 @@

No alert changes

Improved metrics

Total package byte prevSize

34921

increased by3.52%

Number of lines in readme file

182

increased by33.82%

No dependency changes