localtunnel 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 543fdc1332a8724208b1a08e0f67b64f2993be06
-  data.tar.gz: b2c87adc35113cc4fb5c99cb1f1e74eefd0ad4e4
+  metadata.gz: 2a4bde484c6c8c5080e9c4d0bd18248ef8ff62c6
+  data.tar.gz: 1f33eca4f0c3281bbcf90216bb8522df94dfff11
 SHA512:
-  metadata.gz: ea6d2b05cc0bb93b9c2b560239f2d5c8126bffac7f30ea8c381f5374864effde44fba4a34fab6498bf5e6e858f75037ed85af1a1b1dce8e3883ede5e133a9359
-  data.tar.gz: d289b41d5c340a274c020bf5eb4cb939c80a7d78696ca4d811bd7e58af1abc918a8962d1a67e5f46eed38a5e8eb51b7fe7bb447d28ac5e1bfe3b30c9c573c2c2
+  metadata.gz: 2f8d30e20b6cf805fbce77cb355e64fc63e3d8328bf4c0b7f2d20d1640c414380065652aa0c8269186492af433edd9a505d27a871da4ba6a964dd5eaf5fbf6ab
+  data.tar.gz: f9f08b7ecd6754a139b3f0889ea8b0be3ec4f97eb86906e3844b5861132761f1d5e437fc55f3bf5b13f79a71e724f79e21b905b7b523023c7a5594c7040be16c

data/README.md

@@ -1,4 +1,4 @@
-# localtunnel
+# localtunnel [![Gem version](http://img.shields.io/gem/v/localtunnel.svg?style=flat-square)](http://rubygems.org/gems/localtunnel)
 
 Ruby gem wrapping the [localtunnel](https://localtunnel.me/) npm package.
 
@@ -24,4 +24,31 @@ $ npm install -g localtunnel
 
 ## Usage
 
-TODO.
+A basic example:
+
+```ruby
+require 'localtunnel'
+
+Localtunnel::Client.start(port: 3000)
+
+Localtunnel::Client.running? # => true
+
+Localtunnel::Client.url # => https://pnevcucqgb.localtunnel.me
+
+Localtunnel::Client.stop
+```
+
+Extra options can also be specified:
+
+```ruby
+Localtunnel::Client.start(
+  port: 3000,
+  subdomain: 'hello',
+  remote_host: 'http://my-domain-1.com',
+  local_host: 'http://my-domain-2.com'
+)
+```
+
+## Related
+
+It is also worth checking out [ngrok-tunnel](https://github.com/bogdanovich/ngrok-tunnel), a gem that is similar in function to this one and served as its inspiration.

data/lib/localtunnel/version.rb

@@ -1,3 +1,3 @@
 module Localtunnel
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/localtunnel.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0")
   spec.require_paths = ["lib"]
+  spec.post_install_message = "Please ensure that the localtunnel npm package is installed (i.e. `npm install -g localtunnel`)."
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: localtunnel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Swinburne Software Innovation Lab
@@ -58,7 +58,8 @@ homepage: https://github.com/ssilab/localtunnel
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Please ensure that the localtunnel npm package is installed
+  (i.e. `npm install -g localtunnel`).
 rdoc_options: []
 require_paths:
 - lib