From e0d16ce8a20be0c8f15cfb9f568c077ec7366e60 Mon Sep 17 00:00:00 2001 From: Roman Shtylman Date: Mon, 18 Jun 2012 15:48:09 -0400 Subject: [PATCH] add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1bc586 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# localtunnel # + +localtunnel exposes your localhost to the world for easy testing and sharing! No need to mess with DNS or deploy just to have others test out your changes. + +Great for working with browser testing tools like browserling or external api callback services like twilio which require a public url for callbacks! + +## installation ## + +``` +npm install -g localtunnel +``` + +## use ## + +Super East! Assuming your local server is running on port 8000, just use the ```lt``` command to start the tunnel. + +``` +lt --port 8000 +``` + +Thats it! It will connect to the tunnel server, setup the tunnel, and tell you what url to use for your testing. This url will remain active for the duration of your session; so feel free to share it with others for happy fun time! + +You can restart your local server all you want, ```lt``` is smart enough to detect this and reconnect once it is back.