number-to-kurdish-words/README.md
KRG - Department of Information Technology 843eba0f05
Update README.md
2021-03-01 17:59:27 +03:00

46 lines
1.8 KiB
Markdown

# NumbersToKurdishWords
This gem is a Ruby implementation of the NPM package https://github.com/Mawlood-Fareq/kurdish-number-towords/
The algorithm was already developed by the author of the NPM package.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'numbers_to_kurdish_words'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install numbers_to_kurdish_words
## Usage
```ruby
1250.to_words # => هەزار و دوو سەد و پەنجا
100200.to_words # => سەد هەزار و دوو سەد
```
## Development
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.
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 hhttps://github.com/ditdevtools/number-to-kurdish-words. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](hhttps://github.com/ditdevtools/number-to-kurdish-words/blob/master/CODE_OF_CONDUCT.md).
## 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 NumbersToKurdishWords project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ditdevtools/number-to-kurdish-words/blob/master/CODE_OF_CONDUCT.md).