From b0f9f106af696abd93e86ea81d2134840499b240 Mon Sep 17 00:00:00 2001 From: Anton Bogdanovich Date: Wed, 22 Oct 2014 03:45:07 -0700 Subject: [PATCH 1/5] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80eb46a..ecabec1 100644 --- a/README.md +++ b/README.md @@ -23,27 +23,38 @@ Or install it yourself as: ```ruby require 'ngrok/tunnel' -# spawn ngrok +# spawn ngrok at local port 3001 Ngrok::Tunnel.start(3001) # ngrok local_port Ngrok::Tunnel.local_port +=> 3001 + # ngrok external url Ngrok::Tunnel.ngrok_url +=> "http://aaa0e65.ngrok.com" + Ngrok::Tunnel.ngrok_url_https +=> "https://aaa0e65.ngrok.com" Ngrok::Tunnel.running? +=> true + Ngrok::Tunnel.stopped? +=> false # ngrok process id Ngrok::Tunnel.pid +=> 27384 # ngrok log file descriptor Ngrok::Tunnel.log_file +=> # # kill ngrok Ngrok::Tunnel.stop +=> :stopped ``` From a1cf6645fce4ea74147de3eb26d1775daa2c1580 Mon Sep 17 00:00:00 2001 From: Anton Bogdanovich Date: Wed, 22 Oct 2014 03:45:30 -0700 Subject: [PATCH 2/5] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index ecabec1..613aaa4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,6 @@ Ngrok::Tunnel.start(3001) Ngrok::Tunnel.local_port => 3001 - # ngrok external url Ngrok::Tunnel.ngrok_url => "http://aaa0e65.ngrok.com" From 107d7de97d06ab41de1a0f565c2eda2d30c8b47f Mon Sep 17 00:00:00 2001 From: Anton Bogdanovich Date: Wed, 22 Oct 2014 03:46:21 -0700 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 613aaa4..911a9fc 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Ngrok::Tunnel.stop ## Contributing -1. Fork it ( https://github.com/[my-github-username]/ngrok-tunnel/fork ) +1. Fork it ( https://github.com/bogdanovich/ngrok-tunnel/fork ) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) From 793d299997af74ed96aef395933e6422ebb834b2 Mon Sep 17 00:00:00 2001 From: Anton Bogdanovich Date: Wed, 22 Oct 2014 03:59:23 -0700 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 911a9fc..35bb7a1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Ngrok::Tunnel -ngrok-tunnel provides ruby wrapper for ngrok +Ngrok-tunnel gem is a ruby wrapper for ngrok ## Installation From 9986f3e1c8d2244373c2db658b0ab45fcbedcf5c Mon Sep 17 00:00:00 2001 From: Anton Bogdanovich Date: Wed, 22 Oct 2014 18:53:42 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 35bb7a1..28075d6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Ngrok-tunnel gem is a ruby wrapper for ngrok +[![Gem Version](https://badge.fury.io/rb/ngrok-tunnel.svg)](http://badge.fury.io/rb/ngrok-tunnel) + ## Installation Add this line to your application's Gemfile: