@useshortcut/client 1.0.0-beta.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
14
14
|
<a href="https://www.npmjs.org/package/@useshortcut/client">
|
|
15
|
-
<img src="https://badge.fury.io/js/@useshortcut
|
|
15
|
+
<img src="https://badge.fury.io/js/@useshortcut%2Fclient.svg" alt="Current npm package version." />
|
|
16
16
|
</a>
|
|
17
17
|
<a href="https://circleci.com/gh/useshortcut/shortcut-client-js">
|
|
18
18
|
<img src="https://circleci.com/gh/useshortcut/shortcut-client-js.svg?style=shield" alt="Current CircleCI build status." />
|
|
@@ -59,6 +59,8 @@ Requests made with a missing or invalid token will get a `401 Unauthorized` resp
|
|
|
59
59
|
|
|
60
60
|
## Usage
|
|
61
61
|
|
|
62
|
+
To see all available exports, take a look at the [API documentation](https://useshortcut.github.io/shortcut-client-js/) or check out the `.d.ts` files in this repository.
|
|
63
|
+
|
|
62
64
|
```javascript
|
|
63
65
|
import { ShortcutClient } from '@useshortcut/client';
|
|
64
66
|
// const { ShortcutClient } = require('@useshortcut/client');
|
|
@@ -78,4 +80,6 @@ You can play with it in your web browser with this live playground:
|
|
|
78
80
|
|
|
79
81
|
## Documentation
|
|
80
82
|
|
|
83
|
+
[Documentation for this client](https://useshortcut.github.io/shortcut-client-js/).
|
|
84
|
+
|
|
81
85
|
[Documentation for the REST API](https://shortcut.com/api/rest).
|