Browse Source

add readme with initial instructions

Alan Shreve 12 years ago
parent
commit
a7e8b3e2ea
1 changed files with 17 additions and 0 deletions
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -0,0 +1,17 @@
+# ngrok
+
+## 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
+
+
+# Compiling ngrok
+Binaries get placed in ./bin
+
+    git clone git@github.com:inconshreveable/ngrok.git
+    go get -d ./...
+    make
+    bin/ngrok [LOCAL PORT]
+