Skip to content

Commit 1b44663

Browse files
Library name changes in readme
1 parent b75d842 commit 1b44663

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,15 @@
1-
# @reststate/client
2-
3-
**This package is no longer maintained.**
1+
# @codingitwrong/jsonapi-client
42

53
A lightweight client for making requests to a JSON:API service.
64

75
- 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.
86
- It doesn't attempt to abstract away the JSON:API object format; instead, it returns JSON:API data as-is.
97

10-
`@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:
11-
12-
- [Vuex](https://github.com/CodingItWrong/vuex-jsonapi)
13-
- [MobX](https://github.com/CodingItWrong/mobx-jsonapi)
14-
- Coming soon: Redux
15-
168
## Synopsis
179

1810
```javascript
11+
import { ResourceClient } from '@codingitwrong/jsonapi-client';
12+
1913
const resource = new ResourceClient({
2014
name: 'widgets',
2115
httpClient: axios.create(...),
@@ -34,14 +28,14 @@ resource.create({
3428
## Installation
3529

3630
```sh
37-
$ npm install --save @reststate/client
31+
$ npm install --save @codingitwrong/jsonapi-client
3832
```
3933

40-
`@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.
34+
`@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` instance configured with your server's base URL, the standard JSON:API content type, and optionally any authentication info your server requires.
4135

4236
```js
4337
import axios from 'axios';
44-
import { ResourceClient } from '@reststate/client';
38+
import { ResourceClient } from '@codingitwrong/jsonapi-client';
4539

4640
const token = "FILL_ME";
4741

0 commit comments

Comments
 (0)