Browse Source

update docs

Alan Shreve 12 years ago
parent
commit
42c26b40e7
1 changed files with 5 additions and 5 deletions
  1. 5 5
      README.md

+ 5 - 5
README.md

@@ -3,16 +3,16 @@
 ## What is ngrok?
 ngrok is a tool that makes it easier to develop networked services (HTTP/TCP)
 It is a man-in-the-middle proxy server that you run locally on your development box. It allows you to do the following things:
-    - Inspect all http requests/responses sent to/from the proxied application
-    - Expose a local http server to the internet on a subdomain of ngrok.com
+
+- Inspect all http requests/responses sent to/from the proxied application
+- Expose a local http server to the internet on a subdomain of ngrok.com
+- Expose a local tcp server to the internet on a random port on ngrok.com
 
 
 ## Compiling ngrok
 Binaries get placed in ./bin
 
     git clone git@github.com:inconshreveable/ngrok.git
-    cd ngrok
-    go get -d ./...
-    make
+    cd ngrok && make
     bin/ngrok [LOCAL PORT]