feat: add README

2021-03-15 09:10:05 +00:00 · 2021-03-15 09:10:05 +00:00 · a169d72698
commit a169d72698
parent 9114da42d7
1 changed files with 15 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,15 @@
+tls-forward-proxy
+=================
+
+A most basic forward proxy using [Tokio](https://tokio.rs/) [TcpStreams](https://docs.rs/tokio/1.3.0/tokio/net/struct.TcpStream.html).
+
+Sample usage:
+```
+$ cargo build && cargo run
+Listening on 127.0.0.1:8080
+```
+
+Send requests to your destination through this proxy:
+```
+curl --cacert /path/to/cert.pem https://test.dev:5000 -x http://proxy.dev:8080 --proxytunnel
+```