README.md in geezify-rb-0.1.0 vs README.md in geezify-rb-0.2.0

- old
+ new

@@ -1,10 +1,51 @@ -# Geezify Ruby -a set of tools to convert between geez and arabic numbers -## Geezify -is a class to convert arabic numbers to geez -## Arabify -is a class to convert arabic numbers to geez +# Geezify-Rb +Geezify-rb is a gem that converts geez-script numbers to arabic and viceversa. -# The Project is just starting out it needs significant refactoring -## documentation and code quality will improve over time +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'geezify-rb' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install geezify-rb + +## Usage + +```ruby +GeezifyRb::geezify(12) #=> '፲፪' +GeezifyRb::geezify(3033) #=> '፴፻፴፫' +GeezifyRb::geezify(100200000) #=> '፼፳፼' +GeezifyRb::geezify(333333333) #=> '፫፼፴፫፻፴፫፼፴፫፻፴፫' +GeezifyRb::Arabify('፲፪') #=> 12 +GeezifyRb::Arabify('፴፻፴፫') #=> 3033 +GeezifyRb::Arabify('፼፳፼') #=> 100200000 +GeezifyRb::Arabify('፫፼፴፫፻፴፫፼፴፫፻፴፫') #=> 333333333 + +``` + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +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). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/yilkalargaw/geezify-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. + +## License + +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +## Code of Conduct + +Everyone interacting in the Geezify::Rb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yilkalargaw/geezify-rb/blob/master/CODE_OF_CONDUCT.md).