initial commit

README.md

@@ -1,3 +1,34 @@
 # psocks
 
-Experimental async SOCKS5 (TCP/UDP) proxy server based on fast-socks5, featuring allowlist-based access control (drop everything but allowed by user)
+Experimental async SOCKS5 (TCP/UDP) proxy server based on [fast-socks5](https://github.com/dizda/fast-socks5/blob/master/examples/server.rs), featuring allowlist-based access control (drop everything but allowed by user)
+
+## Roadmap
+
+* [ ] Range support
+* [ ] Local Web-API
+  * [ ] Block stats
+  * [ ] In-memory list update (without server restart)
+  * [ ] Performance optimization
+
+## Usage
+
+``` bash
+RUST_LOG=trace cargo run -- -a=/path/to/allow1.txt \
+                            -a=http://localhost/allow2.txt \
+                            no-auth
+```
+
+### Allow list example
+
+``` /path/to/allow1.txt
+# /path/to/allow1.txt
+
+// exact match
+duckduckgo.com
+
+// google.com with subdomains
+.google.com
+
+// IP resolved
+1.2.3.4
+```