README.md in turkish_banks-0.1.0 vs README.md in turkish_banks-0.2.0
- old
+ new
@@ -1,7 +1,10 @@
-# TurkishBanks
+# TurkishBanks
+[![Gem Version](https://badge.fury.io/rb/turkish_banks.svg)](http://badge.fury.io/rb/turkish_banks)
+[![Code Climate](https://codeclimate.com/github/enderahmetyurt/turkish_support/badges/gpa.svg)](https://codeclimate.com/github/enderahmetyurt/turkish_support)
+
Fetch all banks and their information from http://www.tcmb.gov.tr/.
## Installation
Add this line to your application's Gemfile:
@@ -19,18 +22,25 @@
$ gem install turkish_banks
## Usage
```ruby
+# Creates a TurkishBank object
turkish_bank = TurkishBanks::TurkishBank.new
-# Get last update date
+
+# Gets last update date
turkish_bank.last_update_date
-# Get all banks
+
+# Gets all banks
turkish_bank.banks
-# Get information of a bank with the name
-turkish_bank.get_information_of "turkiye cumhuriyeti ziraat bankası a.ş."
-# Get branch of the the bank
-turkish_bank.get_branches_of "turkiye cumhuriyeti ziraat bankası a.ş."
+
+# Returns a bank object
+bank = turkish_bank.get_information_of "türkiye cumhuriyeti ziraat bankası a.ş."
+bank.name # => TÜRKİYE CUMHURİYETİ ZIRAAT BANKASI A.Ş.
+
+# Returns a collection of branch objectes
+branches = turkish_bank.get_branches_of "türkiye cumhuriyeti ziraat bankası a.ş."
+branches.first.name # => "ANKARA ŞUBESİ"
```
## TODO
* Improve search part.