preparing to publish

Nelwhix · Jun 7, 2023 · ff6c005 · ff6c005
1 parent 72c7c35
commit ff6c005
Show file tree

Hide file tree

Showing 6 changed files with 695 additions and 56 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/.vscode
+/node_modules
diff --git a/README.md b/README.md
@@ -1,16 +1,8 @@
 # Serve
-CLI to serve your local sites
-
-## Installation
-the windows amd64 and mac darwin arm64 binaries are on the releases page. If that's not your system arch or OS, you can clone
-the repository and run
-
-```bash
-    go build 
-```
-The cli was built with go 1.20.4
+Golang CLI for starting blazing fast server for your local sites
 
 ## Usage
+For now, Serve supports just HTML, CSS and Javascript
 ```bash
     serve // this starts a server on port 3000
 
@@ -21,3 +13,11 @@ The cli was built with go 1.20.4
     serve -root "path-to-folder"
 ```
 
+For local development, you will need to add this script tag to your html head
+
+```html
+    <script src="https://nelwhix-serve.s3.eu-central-1.amazonaws.com/serve.js"></script>
+```
+this downloads a script that listens for filechange events
+from the server
+
diff --git a/index.html b/index.html
diff --git a/liverserver.js b/liverserver.js