Skip to content

Commit 29b8693

Browse files
committed
docs: update package descriptions
1 parent 10fa5a1 commit 29b8693

4 files changed

Lines changed: 15 additions & 14 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,20 @@
1717
<a href=https://paypal.me/wopian><img alt="support me on paypal.me"src=https://flat.badgen.net/badge/support%20me%20on/paypal.me/pink></a>
1818
</p>
1919

20-
<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>
20+
<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> & other APIs</p>
2121

2222
#
2323

2424
This is a monorepo containing the following packages:
2525

2626
- [kitsu]—Framework agnostic client using Axios
27-
- [kitsu-core]—Framework agnostic (de)serialisation functions
27+
- [kitsu-core]—Framework agnostic (de)serialisation components
2828

2929
## Features
3030

3131
- JSON-API 1.0 compliant
3232
- Automatically links relationships to data
33-
- Works in Node and on the web
33+
- Works in Node & browsers
3434

3535
## Node / Browser Support
3636

@@ -39,7 +39,7 @@ This is a monorepo containing the following packages:
3939
| `kitsu` | ≤ 8.2 kb | 10+ | 69+ | 68+ | 12+ | 18+ |
4040
| `kitsu-core` | ≤ 1.6 kb | 10+ | 69+ | 68+ | 12+ | 18+ |
4141

42-
\* Including all dependencies and minified with brotli
42+
\* Including all dependencies & minified with brotli
4343

4444
## Contributing
4545

packages/kitsu-core/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,18 @@
2424
<a href=https://paypal.me/wopian><img alt="support me on paypal.me"src=https://flat.badgen.net/badge/support%20me%20on/paypal.me/pink></a>
2525
</p>
2626

27-
<p align=center>A simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> serialisation and deserialisation functions</p>
27+
<p align=center>A simple, lightweight & framework agnostic <a href=http://jsonapi.org>JSON:API</a> (de)serialisation components</p>
2828

29-
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu-core/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
29+
<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>
3030

3131
#
3232

3333
## Features
3434

3535
- JSON-API 1.0 compliant
3636
- Automatically links relationships to data
37-
- Works in Node and on the web
37+
- Works in Node & browsers
38+
- Tree shakeable components
3839
- Zero dependencies
3940

4041
## Node / Browser Support

packages/kitsu-core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"version": "9.1.8",
33
"name": "kitsu-core",
4-
"description": "Simple, lightweight & framework agnostic JSON:API (de)serialsation functions",
4+
"description": "Simple, lightweight & framework agnostic JSON:API (de)serialsation components",
55
"author": "James Harris <wopian@wopian.me>",
66
"contributors": [
77
"Brandon Martinez <me@brandonmartinez.com>",

packages/kitsu/README.md

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

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

29-
<p align=center><a href=https://github.com/wopian/kitsu/blob/master/packages/kitsu/MIGRATING.md>Migration guide</a> for v9 and previous major releases</p>
29+
<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>
3030

3131
#
3232

3333
## Features
3434

3535
- JSON-API 1.0 compliant
3636
- Automatically links relationships to data
37-
- Works in Node and on the web
37+
- Works in Node & browsers
3838
- Uses the [Promise] API
3939

4040
## Node / Browser Support
@@ -43,7 +43,7 @@
4343
| ------: | :----------------: | :--: | :----: | :-----: | :----: | :--: |
4444
| `kitsu` | ≤ 8.2 kb | 10+ | 69+ | 68+ | 12+ | 18+ |
4545

46-
\* Including all dependencies and minified with brotli
46+
\* Including all dependencies & minified with brotli
4747

4848
## Response Comparison
4949

@@ -113,8 +113,8 @@ npm install kitsu
113113
```
114114

115115
```js
116-
import Kitsu from 'kitsu' // ES Modules and Babel
117-
const Kitsu = require('kitsu') // CommonJS and Browserify
116+
import Kitsu from 'kitsu' // ES Modules & Babel
117+
const Kitsu = require('kitsu') // CommonJS & Browserify
118118
```
119119

120120
## Quick Start
@@ -175,7 +175,7 @@ api.get('users', {
175175

176176
[More Examples]
177177

178-
If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lists all available resources with their attributes and relationships
178+
If you're working with [Kitsu.io]'s API, their [API docs][kitsu.io api docs] lists all available resources with their attributes & relationships
179179

180180
## API
181181

0 commit comments

Comments
 (0)