locadot 1.2.3 → 1.2.5

package/README.md

@@ -1,20 +1,80 @@
-# 🔐 locadot
-
-Secure your local development environment with **HTTPS** and **custom domains** like `https://dev.localhost`, powered by `mkcert`.
-
----
+# locadot 🔐
 
 ## ✨ Features
 
-- ✅ Automatically generates **trusted local SSL certificates**
-- 🔁 Reverse proxies `https://your.custom.domain` → `app.localhost`
-- 🖥️ Works on **Windows**, **macOS**, and **Linux**
+- ✅ Automatically generates trusted local SSL certificates
+- 🔁 Reverse proxies `https://your.custom.domain` → `localhost:your-port`
+- 🖥️ Works on Windows, macOS, and Linux
 - 🛠️ OS-specific guidance for host setup
 - ⚠️ Warns and exits if domain isn’t correctly mapped to a local IP
+- ❌ Only supports proxying to localhost ports – external IPs are not allowed for security
 
 ---
 
 ## 🚀 Usage
 
 ```bash
-npx locadot --host dev.localhost --port 3350
+npx locadot --host dev.localhost --port 3350
+```
+
+---
+
+## 📦 Commands
+
+##### ▶️ Default (Run Proxy)
+
+###### Starts a reverse proxy to the specified localhost port.
+
+```bash
+npx locadot --host <custom.localhost> --port <localhost-port>
+```
+
+##### 🧾 View Registered Hosts
+
+###### Displays all domains currently registered with locadot.
+
+```bash
+npx locadot host
+```
+
+##### 📺 Watch Logs
+
+###### Continuously watches and outputs proxy logs in real time.
+
+```bash
+npx locadot log
+```
+
+##### 🧹 Clear Logs
+
+###### Clears all saved logs.
+
+```bash
+npx locadot clear logs
+```
+
+##### 🔄 Restart Proxy
+
+###### Restarts the proxy server and reloads configuration.
+
+```bash
+npx locadot restart
+```
+
+##### 🛑 Stop All
+
+###### Stops all running locadot hosts and shuts down the proxy server.
+
+```bash
+npx locadot stop
+```
+
+---
+
+### 🙌 Contributing:
+
+Pull requests are welcome! Feel free to open issues for bugs or feature requests. Contributions help improve locadot for everyone, so don't hesitate to get involved.
+
+---
+
+##### Made with ❤️ to make secure local development simple.

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "locadot",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Secure your local development environment with HTTPS and custom domains like dev.localhost.",
   "homepage": "https://www.npmjs.com/package/locadot",
   "main": "dist/index.js",
   "bin": {
     "locadot": "./dist/index.js"
   },
+  "scripts": {
+    "dev": "tsx --watch src/index.ts",
+    "build": "tsc"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/avinashid/locadot.git"
@@ -38,9 +42,5 @@
   "devDependencies": {
     "tsx": "^4.19.3",
     "typescript": "^5.8.3"
-  },
-  "scripts": {
-    "dev": "tsx --watch src/index.ts",
-    "build": "tsc"
   }
-}
+}