From 88b3273aef65e7d71d817394248ad19ccc4096bb Mon Sep 17 00:00:00 2001
From: Antal Orcsik <antal.orcsik@bitrise.io>
Date: Fri, 10 May 2024 14:56:21 +0200
Subject: [PATCH] new readme for adding scripts

---
 readme.md | 49 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 43 insertions(+), 6 deletions(-)

diff --git a/readme.md b/readme.md
index 57f7e42..a3f3b97 100644
--- a/readme.md
+++ b/readme.md
@@ -1,25 +1,62 @@
 # Webflow Scripts
 
-## Development
+## Adding Standalone Non-compiled Scripts
+
+Create the file in the `dist/standalone/` folder, like 
+
+```
+dist/standalone/my-script.js
+```
+
+After merging into main, it will be available as
+
+```
+https://webflow-scripts.bitrise.io/standalone/my-script.js
+```
+
+## Adding compiled scripts
+
+Create the entry point in the `src/js/` folder. You implement these script like any other JS project with ES6 modules. You can import the CSS files too, they will be included in the compiled bundle. For example:
+
+CSS: `src/css/my-styles.css`
+
+JS: `src/js/my-script.js`
+```javascript
+import { loadCss } from "./shared/common";
+
+loadCss(require("../css/my-styles.css"));
+
+window.addEventListener('load', async () => {
+  console.log('Hello World!');
+});
+```
+
+After merging into main, it will be available as
+
+```
+https://webflow-scripts.bitrise.io/my-script.js
+```
+
+## Developing with the local environment
 
 After cloning, 
 
 build scripts with webpack, use `--watch` if needed
 
-```
+```sh
 yarn build_dev
 ```
 
 and start server with
 
-```
-node index.js <webflow-environment>
+```sh
+node index.js "<webflow-environment>" "<local-domain (optional)>"
 ```
 
-The local server will proxy paths from the `<webflow-environment>` and replace the script with the local one.
+The local server will proxy paths from the `<webflow-environment>` and replace the script that are already embedded in the page with the local one.
 
 ### Using Temp Files
 
 Loading an html file from the temp folder will bypass the webflow proxy.
 
-You have to directly reference the script to be used in the temp file, the replce won't happen in this case.
\ No newline at end of file
+You have to directly reference the script to be used in the temp file, the replace won't happen in this case.
\ No newline at end of file