localtunnel 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 543fdc1332a8724208b1a08e0f67b64f2993be06
4
- data.tar.gz: b2c87adc35113cc4fb5c99cb1f1e74eefd0ad4e4
3
+ metadata.gz: 2a4bde484c6c8c5080e9c4d0bd18248ef8ff62c6
4
+ data.tar.gz: 1f33eca4f0c3281bbcf90216bb8522df94dfff11
5
5
  SHA512:
6
- metadata.gz: ea6d2b05cc0bb93b9c2b560239f2d5c8126bffac7f30ea8c381f5374864effde44fba4a34fab6498bf5e6e858f75037ed85af1a1b1dce8e3883ede5e133a9359
7
- data.tar.gz: d289b41d5c340a274c020bf5eb4cb939c80a7d78696ca4d811bd7e58af1abc918a8962d1a67e5f46eed38a5e8eb51b7fe7bb447d28ac5e1bfe3b30c9c573c2c2
6
+ metadata.gz: 2f8d30e20b6cf805fbce77cb355e64fc63e3d8328bf4c0b7f2d20d1640c414380065652aa0c8269186492af433edd9a505d27a871da4ba6a964dd5eaf5fbf6ab
7
+ data.tar.gz: f9f08b7ecd6754a139b3f0889ea8b0be3ec4f97eb86906e3844b5861132761f1d5e437fc55f3bf5b13f79a71e724f79e21b905b7b523023c7a5594c7040be16c
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # localtunnel
1
+ # localtunnel [![Gem version](http://img.shields.io/gem/v/localtunnel.svg?style=flat-square)](http://rubygems.org/gems/localtunnel)
2
2
 
3
3
  Ruby gem wrapping the [localtunnel](https://localtunnel.me/) npm package.
4
4
 
@@ -24,4 +24,31 @@ $ npm install -g localtunnel
24
24
 
25
25
  ## Usage
26
26
 
27
- TODO.
27
+ A basic example:
28
+
29
+ ```ruby
30
+ require 'localtunnel'
31
+
32
+ Localtunnel::Client.start(port: 3000)
33
+
34
+ Localtunnel::Client.running? # => true
35
+
36
+ Localtunnel::Client.url # => https://pnevcucqgb.localtunnel.me
37
+
38
+ Localtunnel::Client.stop
39
+ ```
40
+
41
+ Extra options can also be specified:
42
+
43
+ ```ruby
44
+ Localtunnel::Client.start(
45
+ port: 3000,
46
+ subdomain: 'hello',
47
+ remote_host: 'http://my-domain-1.com',
48
+ local_host: 'http://my-domain-2.com'
49
+ )
50
+ ```
51
+
52
+ ## Related
53
+
54
+ 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.
@@ -1,3 +1,3 @@
1
1
  module Localtunnel
2
- VERSION = "1.0.0"
2
+ VERSION = "1.0.1"
3
3
  end
@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
14
14
  spec.license = "MIT"
15
15
  spec.files = `git ls-files -z`.split("\x0")
16
16
  spec.require_paths = ["lib"]
17
+ spec.post_install_message = "Please ensure that the localtunnel npm package is installed (i.e. `npm install -g localtunnel`)."
17
18
  spec.add_development_dependency "bundler", "~> 1.10"
18
19
  spec.add_development_dependency "rake", "~> 10.0"
19
20
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: localtunnel
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Swinburne Software Innovation Lab
@@ -58,7 +58,8 @@ homepage: https://github.com/ssilab/localtunnel
58
58
  licenses:
59
59
  - MIT
60
60
  metadata: {}
61
- post_install_message:
61
+ post_install_message: Please ensure that the localtunnel npm package is installed
62
+ (i.e. `npm install -g localtunnel`).
62
63
  rdoc_options: []
63
64
  require_paths:
64
65
  - lib