skikrumb-api 1.0.4 → 1.0.6
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/package.json +1 -1
- package/readme.md +55 -0
- package/README.md +0 -21
package/package.json
CHANGED
package/readme.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
<div style="display: flex; align-items: center;" class="flex">
|
|
2
|
+
<img style="margin-right: 10px" alt="skiKrumb Logo" src="https://happy-meadow-06c70b810-uat.centralus.2.azurestaticapps.net/assets/skikrumb-circle-logo.55442ea5.svg" width="48"/>
|
|
3
|
+
<h1 style="margin: 0; font-size: 30px; line-height: 48px; text-shadow: 1px 1px 2px #111111">skiKrumb</h1>
|
|
4
|
+
</div>
|
|
5
|
+
|
|
6
|
+
#### skiKrumb Tracker Software - © skiKrumb Trackers Inc.
|
|
7
|
+
A wrapper for the skiKrumb API to use in Node.js and Client applications
|
|
8
|
+
## Install skiKrumb API
|
|
9
|
+
```bash
|
|
10
|
+
$ npm i skikrumb-api
|
|
11
|
+
$ yarn add skikrumb-api
|
|
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
|
+
### skiKrumb(options?)
|
|
25
|
+
#### options
|
|
26
|
+
|
|
27
|
+
Type: `object`
|
|
28
|
+
|
|
29
|
+
##### apiKey
|
|
30
|
+
|
|
31
|
+
Type: `string`
|
|
32
|
+
|
|
33
|
+
Your API Key as provided by skiKrumb.
|
|
34
|
+
|
|
35
|
+
##### requestedWith
|
|
36
|
+
|
|
37
|
+
Type: `string`\
|
|
38
|
+
Default: `'skiKrumb API Wrapper'`
|
|
39
|
+
|
|
40
|
+
Sets the `requestedWith` header. Helps with identifying your application.
|
|
41
|
+
|
|
42
|
+
##### url
|
|
43
|
+
|
|
44
|
+
Type: `string`\
|
|
45
|
+
Default: `'https://api.skikrumb.ca'`
|
|
46
|
+
|
|
47
|
+
Defaults to production skiKrumb API URL. Possible values: `https://api-dev.skikrumb.ca` or localhost testing.
|
|
48
|
+
|
|
49
|
+
## API Documentation
|
|
50
|
+
#### [Swagger Documentation](https://api.skikrumb.ca/documentation/static/index.html)
|
|
51
|
+
|
|
52
|
+
> Requires an API key. Request an API Key by emailing info@skikrumb.ca
|
|
53
|
+
|
|
54
|
+
> © skiKrumb
|
|
55
|
+
> `2023`
|
package/README.md
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
<div style="display: flex; align-items: center;" class="flex">
|
|
2
|
-
<img style="margin-right: 10px" alt="skiKrumb Logo" src="https://happy-meadow-06c70b810-uat.centralus.2.azurestaticapps.net/assets/skikrumb-circle-logo.55442ea5.svg" width="48"/>
|
|
3
|
-
<h1 style="margin: 0; font-size: 30px; line-height: 48px; text-shadow: 1px 1px 2px #111111">skiKrumb</h1>
|
|
4
|
-
</div>
|
|
5
|
-
|
|
6
|
-
#### skiKrumb Tracker Software - © skiKrumb Trackers Inc.
|
|
7
|
-
A wrapper for the skiKrumb API to use in Node.js and Client applications
|
|
8
|
-
## Install skiKrumb API
|
|
9
|
-
```bash
|
|
10
|
-
$ yarn add skikrumb-api
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## API Documentation
|
|
14
|
-
#### [Swagger Documentation](https://api.skikrumb.ca/documentation/static/index.html)
|
|
15
|
-
|
|
16
|
-
> Further Documentation to follow
|
|
17
|
-
|
|
18
|
-
> © skiKrumb
|
|
19
|
-
> `2023`
|
|
20
|
-
|
|
21
|
-
|