Merge branch 'main' of https://github.com/CodingItWrong/jsonapi-client

Author: CodingItWrong

.node-version

@@ -1,28 +1,22 @@
-# @reststate/client
+# @codingitwrong/jsonapi-client
 
-**This package is no longer maintained.**
-
-A lightweight client for making requests to a JSON:API service.
+A lightweight client for making requests to a [JSON:API](https://jsonapi.org/) service.
 
 - It doesn't attempt to provide a way to utilize every possible feature of JSON:API; instead, it offers a core set of functionality sufficient for most apps.
 - It doesn't attempt to abstract away the JSON:API object format; instead, it returns JSON:API data as-is.
 
-`@reststate/client` provides a simple Promise-based API suitable for just about any JavaScript application. It doesn't handle persistence, though; for that, wrappers are available for a variety of popular state stores:
-
-- [Vuex](https://github.com/CodingItWrong/vuex-jsonapi)
-- [MobX](https://github.com/CodingItWrong/mobx-jsonapi)
-- Coming soon: Redux
-
 ## Synopsis
 
 ```javascript
+import { ResourceClient } from '@codingitwrong/jsonapi-client';
+
 const resource = new ResourceClient({
   name: 'widgets',
   httpClient: axios.create(...),
 });
 
 resource.all()
-  .then(widgets => widgets);
+  .then(response => console.log(response.data));
 
 resource.create({
   attributes: {
@@ -34,14 +28,20 @@ resource.create({
 ## Installation
 
 ```sh
-$ npm install --save @reststate/client
+$ npm install --save @codingitwrong/jsonapi-client
+```
+
+or
+
+```sh
+$ yarn add @codingitwrong/jsonapi-client
 ```
 
-`@reststate/client` needs to be configured with an `httpClient` object that handles the requests and responses. The easiest way to do this is to provide an `axios` instance configured with your server's base URL, the standard JSON:API content type, and optionally any authentication info your server requires.
+`@codingitwrong/jsonapi-client` needs to be configured with an `httpClient` object that handles the requests and responses. The easiest way to do this is to provide an [`axios`](https://axios-http.com/) instance configured with your server's base URL, the standard JSON:API content type, and optionally any authentication info your server requires.
 
 ```js
 import axios from 'axios';
-import { ResourceClient } from '@reststate/client';
+import { ResourceClient } from '@codingitwrong/jsonapi-client';
 
 const token = "FILL_ME";
 

README.md

@@ -2,18 +2,18 @@
 
 ## all
 
-To retrieve all of the records for a resource, call the `all()` method. The method returns a promise that will resolve to the records:
+To retrieve all of the records for a resource, call the `all()` method. The method returns a promise that will resolve to the server's JSON response:
 
 ```javascript
-resource.all().then(widgets => console.log(widgets));
+resource.all().then(response => console.log(response.data));
 ```
 
 ## find
 
 To retrieve a single record by ID, call the `find()` method:
 
 ```javascript
-resource.find({ id: 42 }).then(widget => console.log(widget));
+resource.find({ id: 42 }).then(response => console.log(response.data));
 ```
 
 ## where
@@ -24,7 +24,7 @@ To filter/query for records based on certain criteria, use the `where` method, p
 const filter = {
   category: 'whizbang',
 };
-resource.where({ filter }).then(widgets => console.log(widgets));
+resource.where({ filter }).then(response => console.log(response.data));
 ```
 
 ## related
@@ -37,7 +37,7 @@ const parent = {
   id: 27,
 };
 
-resource.related({ parent }).then(widgets => console.log(widgets));
+resource.related({ parent }).then(response => console.log(response.data));
 ```
 
 By default, the name of the relationship on `parent` is assumed to be the same as the name of the other model: in this case, `widgets`. In cases where the names are not the same, you can explicitly pass the relationship name:
@@ -52,7 +52,7 @@ const relationship = 'purchased-widgets';
 
 resource
   .related({ parent, relationship })
-  .then(widgets => console.log(widgets));
+  .then(response => console.log(response.data));
 ```
 
 ## Options

deploy.sh

@@ -1,9 +1,9 @@
 {
-  "name": "@reststate/client",
+  "name": "@codingitwrong/jsonapi-client",
   "version": "0.0.9",
   "description": "A vanilla JS client for JSON:API services",
   "main": "index.js",
-  "repository": "[email protected]:reststate/reststate-client.git",
+  "repository": "[email protected]:codingitwrong/jsonapi-client.git",
   "author": "Josh Justice <[email protected]>",
   "license": "Apache-2.0",
   "scripts": {