README.md in maxcube-client-0.4.1 vs README.md in maxcube-client-0.5.0
- old
+ new
@@ -1,7 +1,13 @@
# eQ3/ELV Max! Cube TCP client
+## Download
+
+Ruby [gem](https://rubygems.org/gems/maxcube-client)
+
+[GitHub](https://github.com/Tomaqa/maxcube-client) repository
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -16,13 +22,22 @@
$ gem install maxcube-client
## Usage
-Run `bin/maxcube-client help` and follow instructions. This script starts either TCP or UDP client. UDP client is used only for device discovering purposes yet.
+Run `bin/maxcube-client help` and follow instructions. This script starts either TCP or UDP client. UDP client is used only for device discovery purposes yet.
+
You can also run `bin/console`, if you want to to handle objects yourself.
-Yet there are sample servers: `bin/sample_server` (TCP) and `bin/sample_socket` (UDP), but only with very basic functions. However, they can be used to try simple connection with client.
+Yet there are sample servers: `bin/sample_server` (TCP) and `bin/sample_socket` (UDP), but only with very basic features. However, they can be used to try simple connection with client.
+
+## Documentation
+
+Project is documented using YARD.
+
+MAX! Cube protocol itself is not documented here though.
+You should have a look [here](https://github.com/Bouni/max-cube-protocol),
+where I derived vast of specifications from.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.