Skip to content

Commit 6a73433

Browse files
committed
docs: update README
1 parent 8254710 commit 6a73433

3 files changed

Lines changed: 9 additions & 8 deletions

File tree

packages/kitsu-core/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
<p align=center>Core <a href=http://jsonapi.org>JSON:API</a> serialisation and deserialisation components</p>
2828

29-
#
29+
#
3030

3131
## Features
3232

@@ -38,7 +38,7 @@
3838

3939
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
4040
| ------------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
41-
| `kitsu-core`| ≤ 1.2 kb | 10+ | 65+ | 65+ | 11.1+ | 17+ |
41+
| `kitsu-core`| ≤ 1.3 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
4242

4343
\* Including all dependencies, minified & gzipped<br>
4444

@@ -225,7 +225,7 @@ Filters includes for the specific relationship
225225
#### Parameters
226226

227227
- `included` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** The response included object
228-
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
228+
- `opts` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
229229
- `opts.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
230230
- `opts.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
231231

packages/kitsu-core/src/splitModel/index.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11

22
/**
3-
* splitModel
3+
* Split model name from the model's resource URL
44
*
5+
* @name splitModel
56
* @param {string} url URL path for the model
67
* @param {Object} options
78
* @param {Function} options.resourceCase Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core

packages/kitsu/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
<p align=center>A simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> client for <a href=https://kitsu.io>Kitsu.io</a> and other APIs</p>
2828

29-
#
29+
#
3030

3131
## Features
3232

@@ -40,7 +40,7 @@
4040

4141
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
4242
| -------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
43-
| `kitsu`| ≤ 8.4 kb | 10+ | 65+ | 65+ | 11.1+ | 17+ |
43+
| `kitsu`| ≤ 8.5 kb | 10+ | 79+ | 68+ | 12.1+ | 18+ |
4444

4545
\* Including all dependencies, minified & gzipped
4646

@@ -49,7 +49,7 @@
4949
## Response Comparison
5050

5151
<details>
52-
<summary>A GET response by a JSON:API server</summary>
52+
<summary>Object from a GET Response by a JSON:API Server</summary>
5353

5454
```json5
5555
{
@@ -83,7 +83,7 @@
8383
</details>
8484

8585
<details open>
86-
<summary>A GET response with kitsu:</summary>
86+
<summary>Object from a GET Response with kitsu:</summary>
8787

8888
```json5
8989
{

0 commit comments

Comments
 (0)