README.md in ligo-0.1.0 vs README.md in ligo-0.1.1
- old
+ new
@@ -1,8 +1,10 @@
<!--- coding: utf-8; fill-column: 80 --->
# ligō
+[](https://codeclimate.com/github/nibua-r/ligo)
+
* [Homepage](https://github.com/nibua-r/ligo#readme)
* [Issues](https://github.com/nibua-r/ligo/issues)
* [Documentation](http://rubydoc.info/gems/ligo/frames)
* [Email](mailto:root at renaud.io)
@@ -69,27 +71,40 @@
[sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo)
is available for usage demonstration.
## Install
-ligō is currently under developement, as a consequence you'll need to live on the edge:
+You may install ligō by using:
+ $ gem install ligo
+
+Or, you can install it from the github repository:
+
$ git clone https://github.com/nibua-r/ligo.git
$ cd ligo
$ rake install
-As soon as the ligō gem is released, you shall install by using:
- $ gem install ligo
-
## Pending tasks
* Write the specs and automate testing!
-* Provide an Android demo application
-* Improve the documentation
-* Release and push the gem to rubygems.org
+* <s>Provide an Android demo application</s> → See
+ [sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo),
+ more to come soon…
+* Improve the documentation → in progress, a first pass has been made…
+* <s>Release and push the gem to rubygems.org</s>
+* Finalize and publish a [celluloid](https://github.com/celluloid/celluloid)-based write-back usage
+ sample (already working with the
+ [sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo) and the
+ [libusb 0.3.0 gem](https://github.com/larskanis/libusb) async and polling APIs)
+* Create a wiki with FAQ, supported devices listing, UMS/accessory interactions, etc.
+## Contributing to ligō
+
+* Follow the usual fork/branch/PR workflow to send changes, if I like them I'll merge them
+* Help me to create a supported device listing
+
## Copyright
-Copyright (c) 2012 Renaud AUBIN
+Copyright (c) 2012, 2013 Renaud AUBIN
See {file:LICENSE.txt} for details.