mpk-krakow-rb

Ruby library for fetching schedules for MPK Krakow.
git clone git://vcs.sapka.me/mpk-krakow-pl
Log | Files | Refs | README

README.md (1463B)

      1 # MpkKrakowRb
      2 
      3 A Ruby wrapper for [Miejskie Przedsiebiorstwo Komunikacyjne](http://www.mpk.krakow.pl) routes, stops and timetables data.
      4 
      5 ## Installation
      6 
      7 Add this line to your application's Gemfile:
      8 
      9 ```ruby
     10 gem 'mpk_krakow_rb'
     11 ```
     12 
     13 And then execute:
     14 
     15     $ bundle
     16 
     17 Or install it yourself as:
     18 
     19     $ gem install mpk_krakow_rb
     20 
     21 ## Usage
     22 
     23 TODO: write
     24 
     25 ## Code status
     26 
     27 [![Build Status](https://travis-ci.org/michalsapka/mpk_krakow_rb.svg)](https://travis-ci.org/michalsapka/mpk_krakow_rb)
     28 
     29 ## Development
     30 
     31 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.
     32 
     33 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).
     34 
     35 ## Contributing
     36 
     37 Bug reports and pull requests are welcome on GitHub at https://github.com/michalsapka/mpk_krakow_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
     38 
     39 
     40 ## License
     41 
     42 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
     43