http-server-rs 0.0.19 → 0.0.21

package/README.md

@@ -11,36 +11,66 @@ https://github.com/user-attachments/assets/7b6bbee0-3428-4c9f-80a6-2804ddac6e01
 ### Cargo
 
 ```bash
-# Rerun to update
+# Installs globally
 cargo install http-server-rs
 ```
 
-### Binary Install Script
+### NPM
 
 ```bash
-# Rerun to update
-eval $(curl -sSf https://raw.githubusercontent.com/alshdavid/http-server-rs/refs/heads/main/install.sh | sh)
+# Installs to ./node_modules
+npm install http-server-rs
+npx http-server-rs --help
 ```
 
-## Usage
+If you want to override the binary used (for custom platforms)
+```bash
+npm install http-server-rs
+
+export HTTP_SERVER_RS_BIN_OVERRIDE=/path/to/http-server-rs
+npx http-server-rs --help # Uses the override
+```
+
+### Manual Install
+
+Download the latest binary from [GitHub Releases](https://github.com/alshdavid-public/http-server-rs/releases/latest) and add it to your `PATH`
+
+```bash
+# Linux AMD64 (Change for your platform)
+curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-rs-linux-amd64.tar.gz | tar -xvzf - -C $HOME/.local/bin
+
+# Add to PATH if not already there:
+echo "\nexport \PATH=\$PATH:\$HOME/.local/bin\n" >> $HOME/.zshrc
+echo "\nexport \PATH=\$PATH:\$HOME/.local/bin\n" >> $HOME/.bashrc
+```
+
+## Example Usage
 
 ```bash
 # Use default configuration
-http-server
+http-server-rs
+
+# Enable CORS, reroute requests to index.html and automatically compress served files
+http-server-rs --cors --spa -Z ./public
+
+# Responds with headers required for SharedArrayBuffer
+http-server-rs --shared-array-buffer ./public
+
+# Automatically transpiles TypeScript to JavaScript on request
+http-server-rs --transpile ./public
 
-# Arguments
-# Enable CORS, reroute requests to index.html and automatically compress to brotli 
-http-server --cors --spa -Z ./public
+# Proxy /api to an external backend (quotes are required)
+http-server-rs --proxy "path=/api&target=http://localhost:3000" ./public
 
 # Custom Headers
-http-server -H X-Custom-Header:some-value
+http-server-rs -H X-Custom-Header:some-value
 ```
 
 ```
 Usage: http-server-rs [OPTIONS] [SERVE_DIR]
 
 Arguments:
-  [SERVE_DIR]  Target directory to serve [default: ./dist]
+  [SERVE_DIR]  Target directory to serve [default: ./]
 
 Options:
   -a, --address <ADDRESS>
@@ -127,16 +157,16 @@ Download the binary from the [latest GitHub release](https://github.com/alshdavi
 
 ```shell
 # Linux AMD64
-curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-linux-amd64.tar.gz | tar -xvzf - -C $HOME/.local/bin
+curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-rs-linux-amd64.tar.gz | tar -xvzf - -C $HOME/.local/bin
 
 # Linux ARM64
-curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-linux-arm64.tar.gz | tar -xvzf - -C $HOME/.local/bin
+curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-rs-linux-arm64.tar.gz | tar -xvzf - -C $HOME/.local/bin
 
 # MacOS ARM64 (Apple Silicon)
-curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-macos-arm64.tar.gz | tar -xvzf - -C $HOME/.local/bin 
+curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-rs-macos-arm64.tar.gz | tar -xvzf - -C $HOME/.local/bin 
 
 # MacOS AMD64 (Intel)
-curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-macos-amd64.tar.gz | tar -xvzf - -C $HOME/.local/bin
+curl -L --url https://github.com/alshdavid/http-server-rs/releases/latest/download/http-server-rs-macos-amd64.tar.gz | tar -xvzf - -C $HOME/.local/bin
 
 # Add to PATH if not already there:
 echo "\nexport \PATH=\$PATH:\$HOME/.local/bin\n" >> $HOME/.zshrc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-server-rs",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "license": "MIT",
   "type": "module",
   "bin": {