Skip to content

Commit 469d23a

Browse files
committed
docs: update READMEs
1 parent eb79c78 commit 469d23a

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

packages/kitsu-core/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222

2323
<p align=center>Simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> (de)serialisation components</p>
2424

25-
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v9 & previous major releases</p>
25+
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v10 & previous major releases</p>
2626

27-
#
27+
#
2828

2929
## Features
3030

@@ -36,11 +36,12 @@
3636

3737
## Node / Browser Support
3838

39-
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
40-
| -----------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
41-
| `kitsu-core` | ≤ 1.6 kb | 10+ | 69+ | 68+ | 12+ | 18+ |
39+
| Package | Package<br> Size\* | ESM Size† | Node | Chrome | Firefox | Safari | Edge |
40+
| -----------: | :----------------: | :-------: | :--: | :----: | :-----: | :----: | :--: |
41+
| `kitsu-core` | ≤ 1.5 kb | ≤ 1.3 KB | 10+ | 69+ | 68+ | 12+ | 18+ |
4242

4343
\* Minified with brotli
44+
† EcmaScript Modules package size\*
4445

4546
## Install
4647

@@ -254,7 +255,7 @@ Filters includes for the specific relationship requested
254255
#### Parameters
255256

256257
- `included` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** The response included object
257-
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
258+
- `relationship` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
258259
- `relationship.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship ID
259260
- `relationship.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The relationship type
260261

packages/kitsu/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222

2323
<p align=center>A simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> client using Axios</p>
2424

25-
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 & previous major releases</p>
25+
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v10 & previous major releases</p>
2626

27-
#
27+
#
2828

2929
## Features
3030

@@ -35,11 +35,12 @@
3535

3636
## Node / Browser Support
3737

38-
| Package | Package<br> Size\* | Node | Chrome | Firefox | Safari | Edge |
39-
| ------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
40-
| `kitsu` | ≤ 8.2 kb | 10+ | 69+ | 68+ | 12+ | 18+ |
38+
| Package | Package<br> Size\* | ESM Size† | Node | Chrome | Firefox | Safari | Edge |
39+
| ------: | :----------------: | :-------: | :--: | :----: | :-----: | :----: | :--: |
40+
| `kitsu` | ≤ 8.6 kb | ≤ 8.4 KB | 10+ | 69+ | 68+ | 12+ | 18+ |
4141

4242
\* Including all dependencies & minified with brotli
43+
† EcmaScript Modules package size\*
4344

4445
## Response Comparison
4546

0 commit comments

Comments
 (0)