mpk-krakow-rb

commit f26780b64478928bf541b58190e4629f6033ab81
parent 23d6822e1bef0cc4e0142f26e7bcfcb2420cfa2d
Author: Michal Sapka <msapka@gmail.com>
Date:   Sun,  8 Nov 2015 00:56:00 +0100

Readme update

Diffstat:
M
README.md
 | 
20
+++++++-------------

1 file changed, 7 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -1,16 +1,6 @@
 # MpkKrakowRb
-[![Build Status](https://travis-ci.org/michalsapka/mpk_krakow_rb.svg)](https://travis-ci.org/michalsapka/mpk_krakow_rb)
-
-## Ruby versions
-This gem is tested against:
-
-  - 2.2.0
-  - ruby-head
-  - jruby-head
- 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mpk_krakow_rb`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+A Ruby wrapper for [Miejskie Przedsiebiorstwo Komunikacyjne](http://www.mpk.krakow.pl) routes, stops and timetables data.
 
 ## Installation
 
@@ -30,7 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: write
+
+## Code status
+
+[![Build Status](https://travis-ci.org/michalsapka/mpk_krakow_rb.svg)](https://travis-ci.org/michalsapka/mpk_krakow_rb)
 
 ## Development
 
@@ -40,7 +34,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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.
+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.
 
 
 ## License