Commit 170bd75

mo khan <mo@mokhan.ca>
2021-11-12 21:46:32
docs: add install and usage to README
1 parent 692775e
Changed files (2)
main.go
@@ -26,7 +26,7 @@ var (
 	password    = *flag.String("password", "", "password")
 	certificate = *flag.String("certificate", "", "certificate")
 	key         = *flag.String("key", "", "key")
-	host        = *flag.String("host", "localhost", "host")
+	host        = *flag.String("host", "127.0.0.1", "host")
 	port        = *flag.String("port", "8080", "port")
 	verbose     = *flag.Bool("verbose", false, "verbosity")
 )
README.md
@@ -3,6 +3,23 @@
 A tiny proxy server.
 
 
+## Installation
+
+```bash
+$ go install github.com/xlg-pkg/proxy-server@latest
+```
+
+## Usage
+
+Start the server:
+
+```bash
+$ proxy-server
+Listening and serving HTTP on http://127.0.0.1:8080
+```
+
+Use the proxy server:
+
 ```bash
-$ curl -k --proxy http://localhost:8080 https://www.eff.org/
+$ curl -k --proxy 127.0.0.1:8080 https://www.eff.org/
 ```