storyly-web 1.0.0 → 1.0.2

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,41 +1,27 @@
1
1
  # Storyly Web
2
2
 
3
- Web stories for Storyly
3
+ To add Storyly Web SDK to your project using npm, please use one of the following methods:
4
+
4
5
 
5
- ## Installation
6
-
7
- Clone
8
-
9
- ```bash
10
- git clone https://github.com/Netvent/storyly-web.git
11
- ```
12
-
13
- Go to project folder
14
-
15
- ```bash
16
- cd storyly-web
6
+ ```Text Yarn
7
+ yarn add storyly-web
17
8
  ```
18
9
 
19
- Install mkcert for http certificas
10
+ or
20
11
 
21
- ```bash
22
- brew install mkcert
12
+ ```Text npm
13
+ npm install storyly-web
23
14
  ```
24
15
 
25
- Run command in project folder
16
+
17
+ Import `storyly-web` to where you register global components, like **main.js**.
18
+
19
+ That way, you would not need to import `storyly-web` under different pages several times.
20
+
26
21
 
27
- ```bash
28
- mkcert dev.storyly
22
+ ```Text HTML
23
+ import 'storyly-web';
29
24
  ```
30
25
 
31
- Install packages
32
-
33
- ```bash
34
- yarn
35
- ```
36
-
37
- Run project
38
-
39
- ```bash
40
- yarn start
41
- ```
26
+
27
+ For further information regarding the usage of `storyly-web`, please check out [docs](https://docs.storyly.io/docs/initial-web-sdk-setup).