skapi-js 0.1.44 → 0.1.45

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 CHANGED
@@ -1,31 +1,40 @@
1
1
  # skapi
2
2
 
3
- skapi is a serverless backend API for JAM stack developers.
3
+ Serverless-based backend API service designed to simplify your application's security and database management.
4
4
 
5
- Build fast and scalable web services based on skapi's serverless technology.
6
5
 
7
- skapi is built to work well on both plain HTML and Webpack projects.
6
+ ## For HTML projects
8
7
 
9
- 100% Serverless. No maintenance or CLI installation is required.
8
+ To import skapi into an HTML project, add the following script to the head tag of your HTML file:
10
9
 
11
- <br>
12
-
13
- # Features
14
- - Auto indexed scalable database.
15
- - Authentication for web services.
16
- - Cloud storage.
17
- - E-Mail newsletters to customers.
18
- - Web hosting.
19
-
20
- <br>
21
-
22
- # Getting started
23
-
24
- ```
10
+ ```html
11
+ <!DOCTYPE html>
12
+ <html>
25
13
  <head>
26
- <script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js">
14
+ <script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
15
+ ...
27
16
  </head>
17
+ <body>
18
+ ...
19
+ </body>
28
20
  <script>
29
- const skapi = new Skapi('your_service_id', 'your_user_id');
21
+ const skapi = new Skapi('your_service_id', 'your_user_id');
30
22
  </script>
23
+ </html>
24
+ ```
25
+
26
+ ## For webpack projects
27
+
28
+ To use skapi in a webpack-based project (such as Vue, React, or Angular), first install skapi-js from npm:
29
+
30
+ ```sh
31
+ $ npm install skapi-js@latest
32
+ ```
33
+
34
+ Then, import the library into your main JavaScript file:
35
+
36
+ ```javascript
37
+ // main.js
38
+ import { Skapi } from 'skapi-js';
39
+ const skapi = new Skapi('your_service_id', 'your_user_id');
31
40
  ```