skapi-js 0.1.68 → 0.1.69
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 +12 -3
- package/dist/skapi.js +1 -1
- package/dist/skapi.js.map +1 -1
- package/dist/skapi.module.js +1 -1
- package/dist/skapi.module.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
# skapi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Complete JAM Stack, front-end driven backend API service designed to simplify the web development.
|
|
4
4
|
|
|
5
5
|
## For HTML projects
|
|
6
6
|
|
|
7
7
|
```html
|
|
8
8
|
<!DOCTYPE html>
|
|
9
9
|
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
|
|
10
|
+
<body>
|
|
11
|
+
...
|
|
12
|
+
</body>
|
|
10
13
|
<script>
|
|
11
14
|
const skapi = new Skapi('your_service_id', 'your_user_id');
|
|
15
|
+
// ... Start Coding!
|
|
12
16
|
</script>
|
|
13
17
|
```
|
|
14
18
|
|
|
15
19
|
## For webpack projects
|
|
16
20
|
|
|
17
|
-
To use skapi in a webpack-based project (such as Vue, React, or Angular),
|
|
21
|
+
To use skapi in a webpack-based project (such as Vue, React, or Angular), install skapi-js from npm:
|
|
18
22
|
|
|
19
23
|
```sh
|
|
20
24
|
$ npm install skapi-js@latest
|
|
@@ -26,4 +30,9 @@ Then, import the library into your main JavaScript file:
|
|
|
26
30
|
// main.js
|
|
27
31
|
import { Skapi } from 'skapi-js';
|
|
28
32
|
const skapi = new Skapi('your_service_id', 'your_user_id');
|
|
29
|
-
|
|
33
|
+
|
|
34
|
+
// Import the exported class from any file you may want to use skapi
|
|
35
|
+
export { skapi };
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
For more info, visit our [documentation page](docs.skapi.com)
|