README.md in bikepoa-tools-0.2.0 vs README.md in bikepoa-tools-0.3.0

- old
+ new

@@ -2,18 +2,37 @@ [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fmobus/bikepoa-tools) bikepoa-tools ============= -A simple API to interact with information systems of [BikePOA](http://mobilicidade.com.br/bikepoa/), the +Gem containing a simple API to interact with information systems of [BikePOA](http://mobilicidade.com.br/bikepoa/), the bicycle-sharing program of Porto Alegre, Brazil. +installation +============ + +To install the version that was released as a gem most recently, simply use + +``` +~$ gem install bikepoa-tools +``` + +If you want to be on top of things and use the latest github version, use + +``` +~$ git clone git@github.com:fmobus/bikepoa-tools.git +~$ cd bikepoa-tools +~/bikepoa-tools$ rake build +~/bikepoa-tools$ rake install +``` + + usage ===== ```ruby ->>> require './lib/bikepoa' +>>> require 'bikepoa' >>> client = BikePOA::Client.new >>> client.stations [ <BikePOA::Station:0x007fd60191aeb8 @id="1", @online="A", @status="EO", @size="12", @available="6" @@ -36,11 +55,10 @@ "<Station:Escola Parob\xE9, 3/12>", "<Station:Regi\xE3o dos Tribunais, 5/12>" ] ``` -todo +Wishlist ==== -* Package it as a gem * Add latitude and longitude to Station * Less crude interface in Station