README.md in cnab-0.1.0 vs README.md in cnab-0.2.0

- old
+ new

@@ -1,10 +1,11 @@ # Cnab [![Gem Version](https://badge.fury.io/rb/cnab.png)](http://badge.fury.io/rb/cnab) [![Build Status](https://travis-ci.org/zertico/cnab.png)](https://travis-ci.org/zertico/cnab) [![Coverage Status](https://coveralls.io/repos/zertico/cnab/badge.png?branch=master)](https://coveralls.io/r/zertico/cnab) [![Code Climate](https://codeclimate.com/github/zertico/cnab.png)](https://codeclimate.com/github/zertico/cnab) -Gem used to parse return from Brazil banks in format of cnab files. +Gem used to parse return from Brazil banks in format of cnab files. It is based on the version 08.7 of the cnab. +Right now it has support only for Segmento T and Segmento U. ## Installation Add this line to your application's Gemfile: @@ -18,13 +19,28 @@ $ gem install cnab ## Usage -TODO: Write usage instructions here +```ruby +cnab = Cnab.parse('path/to/your/file') +``` +This method will return the file parsed in objects. + +If you need to merge the segments T and U, just pass true as the optional parameter: + +```ruby +cnab = Cnab.parse('path/to/your/file', true) +``` + +## TODO + +* Add support for another type of segments + ## Mantainers [@plribeiro3000](https://github.com/plribeiro3000) + [@mfbmina](https://github.com/mfbmina) ## Contributing 1. Fork it