README.md in twib-0.1.0 vs README.md in twib-0.1.1
- old
+ new
@@ -1,6 +1,7 @@
# ruby-twib
+[](https://badge.fury.io/rb/twib)
[Twili](https://github.com/misson20000/twili) bridge client for Ruby, providing a way for Ruby applications to send requests to a Twili device via twibd.
## Installation
@@ -20,23 +21,25 @@
## Usage
See the instructions on the [Twili repository](https://github.com/misson20000/twili#twili) for how to set up Twili and twibd.
-First, create a Twib::TwibConnection. There is a convenience method `Twib::TwibConnection::connect_unix`
+First, create a [Twib::TwibConnection](https://www.rubydoc.info/gems/twib/Twib/TwibConnection). There is a convenience method [Twib::TwibConnection::connect_unix](https://www.rubydoc.info/gems/twib/Twib/TwibConnection#connect_unix-class_method).
```ruby
+> require "twib"
+ => true
> tc = Twib::TwibConnection.connect_unix
=> #<Twib::TwibConnection:...>
```
-After that, you can list the available devices with `TwibConnection#list_devices`, which returns an array of hashes identifying each device.
+After that, you can list the available devices with [TwibConnection#list_devices](https://www.rubydoc.info/gems/twib/Twib/TwibConnection#list_devices-instance_method), which returns an array of hashes identifying each device.
```ruby
> tc.list_devices
[{"device_id"=>507914862, ...}, ...]
```
-Use `TwibConnection#open_device` to get a device's `ITwibDeviceInterface`.
+Use [TwibConnection#open_device](https://www.rubydoc.info/gems/twib/Twib/TwibConnection#open_device-instance_method) to get a device's [ITwibDeviceInterface](https://www.rubydoc.info/gems/twib/Twib/Interfaces/ITwibDeviceInterface).
```ruby
> tc.open_device(507914862)
=> #<Twib::Interfaces::ITwibDeviceInterface:...>
```
@@ -47,5 +50,15 @@
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/misson20000/ruby-twib.
+
+## License
+
+```
+Copyright 2018 misson20000
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+```