Skip to content

Commit d7f6dce

Browse files
committed
update readme
1 parent 8cc6cc2 commit d7f6dce

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

readme.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ To install the project, follow these steps:
88

99
1. Clone the repository to your local machine.
1010
2. Install dependencies by running `npm install`.
11-
3. Change your site ID from `user.config.cjs` file
11+
3. Change your site ID inside the `user.config.cjs` file (You can see your webflow site ID at the general settings of the site)
12+
4. Add javascript files inside the scripts folder (so you can run command below against them)
13+
5. Start your dev server by running`npm run dev`. for more please read below.
14+
1215

1316
## Commands
1417

1518
### Authentication
1619

1720
Authenticate your CLI instance with an authorization code.
21+
To get the authCode please refer to the app website at https://webflow-local-bridge.replit.app/
1822

1923
```bash
2024
npm run auth -- auth --authCode <authCode>
@@ -24,6 +28,8 @@ npm run auth -- auth --authCode <authCode>
2428

2529
Upload a file to the Webflow assets.
2630

31+
The script has to be located inside the scripts folder
32+
2733
```bash
2834
npm run upload -- push --file <filename>
2935
```
@@ -32,6 +38,9 @@ npm run upload -- push --file <filename>
3238

3339
Register a script with a specific version.
3440

41+
Note : The first time you create a new file remember to register it's dev version (`npm run register -- register --version=dev --file=test.js `, which will automatically register the localhost url) then you can switch to that dev version whenever you want to start development and see changes live.
42+
43+
3544
```bash
3645
npm run register -- register --version=<version> --file=<filename>
3746
```
@@ -44,29 +53,19 @@ Attach a script to a Webflow page.
4453
npm run set -- attach --pageId <pageId> --file <filename> --version <version> --location <location>
4554
```
4655

56+
For the `Set command` to take effect you have to deploy the site from your designer
57+
58+
4759
### Unset
4860

4961
Detach a script from a Webflow page.
5062

5163
```bash
5264
npm run unset -- detach --pageId <pageId> --file <filename>
53-
```
54-
55-
### Attach
5665

57-
Attach a script to a Webflow page.
58-
59-
```bash
60-
npm run attach -- attach --pageId <pageId> --file <filename> --version <version> --location <location>
6166
```
67+
For the `Unset command` to take effect you have to deploy the site from your designer
6268

63-
### Detach
64-
65-
Detach a script from a Webflow page.
66-
67-
```bash
68-
npm run detach -- detach --pageId <pageId> --file <filename>
69-
```
7069

7170
### Show Registered
7271

0 commit comments

Comments
 (0)