README.md in lxi_rb-0.7.1 vs README.md in lxi_rb-0.7.2
- old
+ new
@@ -1,27 +1,34 @@
# lxi_rb
[![Gem Version](https://img.shields.io/gem/v/lxi_rb?color=green)](https://badge.fury.io/rb/lxi_rb) ![Ruby](https://img.shields.io/static/v1?message=Ruby&color=red&logo=Ruby&logoColor=FFFFFF&label=v3.1.2) ![Ruby](https://img.shields.io/gitlab/license/robcarruthers/rfbeam?color=orange)
-Ruby wrapper for the [liblxi](https://github.com/lxi-tools/liblxi) library.
+Ruby wrapper for the [liblxi](https://github.com/lxi-tools/liblxi) library, which offers a simple API for communicating with LXI compatible instruments.
## Installation
+The gem requires the liblxi library to be installed on the system. The library can be installed and macOS or Linux using [Homebrew](https://brew.sh/)
+
+```shell
+brew install liblxi
+```
+
Install the gem and add to the application's Gemfile by executing:
-``` shell
+```shell
bundle add lxi_rb
```
If bundler is not being used to manage dependencies, install the gem by executing:
-``` shell
+
+```shell
gem install lxi_rb
```
## Usage
-``` ruby
+```ruby
Lxi.search
Searching for LXI devices - please wait...
Broadcast: 127.0.0.1, lo0
Broadcast: 192.168.10.255, en0
@@ -46,10 +53,10 @@
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 the created tag, 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/[USERNAME]/lxi_rb>.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/robcarruthers/lxi_rb>.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).