skikrumb-api 1.0.4 → 1.0.5
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 +13 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,13 +7,25 @@
|
|
|
7
7
|
A wrapper for the skiKrumb API to use in Node.js and Client applications
|
|
8
8
|
## Install skiKrumb API
|
|
9
9
|
```bash
|
|
10
|
+
$ npm i skikrumb-api
|
|
10
11
|
$ yarn add skikrumb-api
|
|
11
12
|
```
|
|
12
13
|
|
|
14
|
+
## Example
|
|
15
|
+
```javascript
|
|
16
|
+
import skiKrumb from 'skikrumb-api';
|
|
17
|
+
|
|
18
|
+
const {readDeviceData} = skiKrumb({
|
|
19
|
+
apiKey: 'YOUR_API_KEY',
|
|
20
|
+
requestedWith: 'My Application Name',
|
|
21
|
+
url: 'Defaults to http://api.skikrumb.ca'
|
|
22
|
+
})
|
|
23
|
+
```
|
|
24
|
+
|
|
13
25
|
## API Documentation
|
|
14
26
|
#### [Swagger Documentation](https://api.skikrumb.ca/documentation/static/index.html)
|
|
15
27
|
|
|
16
|
-
>
|
|
28
|
+
> Requires an API key. Request an API Key by emailing info@skikrumb.ca
|
|
17
29
|
|
|
18
30
|
> © skiKrumb
|
|
19
31
|
> `2023`
|