README.md in turkish_id-0.4.0 vs README.md in turkish_id-0.5.0
- old
+ new
@@ -20,87 +20,85 @@
$ gem install turkish_id
## Usage
+### Validating ID Numbers
+
Create a new instance:
```rb
identity_number = TurkishId.new(10000000146)
```
Use ```is_valid?``` method to check validity:
```rb
-identity_number.is_valid?
-=> true
+identity_number.is_valid? #=> true
```
Or use the command line executable:
```sh
-$ turkish_id 10000000078
-Your identification number is valid.
+$ turkish_id 10000000078 #=> Your identification number is valid.
```
-## Anatomy of the Turkish ID Number
+### Generating Relatives
-The Turkish Identification Number consists of ```11``` digits.
-
-There are three conditions for a valid identification number:
-
-1. ```d1 > 0```
-2. ```d10 == ((d1 + d3 + d5 + d7 + d9) * 7 - (d2 + d4 + d6 + d8)) mod 10```
-3. ```d11 == (d1 + d2 + d3 + d4 + d5 + d6 + d8 + d9 + d10) mod 10```
-
-Where ```dn``` refers to the ```n-th``` digit of the identification number.
-
-Remember that a valid identification number does not imply the existence of an ID. It could only be used as a preliminary check e.g. before querying a government website. This is very similar to credit card validation.
-
-
-## Generating Relatives
-
You can generate ID numbers for your younger or elder relatives.
```rb
me = TurkishId.new(10000000146)
-me.elder_relatives.take(5)
```
Calling `younger_relative` or `elder_relative` will return an Enumerable class.
```rb
-me.elder_relative
-#=> #<Enumerator:0x00007f9e629032d0>
+me.elder_relative #=> #<Enumerator:0x00007f9e629032d0>
```
You can perform standard Enumerable operations on it.
```rb
-me.elder_relative.first
-
-#=> 10003000082
+me.elder_relative.first #=> 10003000082
```
```rb
3.times do
- puts me.elder_relative.next()
+ puts me.elder_relative.next
end
#=> 10035998982
#=> 10005999902
#=> 10008999848
```
```rb
-me.elder_relative.take(5)
-
-#=> [10003000082, 10005999902, 10008999848, 10011999774, 10014999610]
+me.elder_relative.take(5) #=> [10003000082, 10005999902, 10008999848, 10011999774, 10014999610]
```
And so on.
+## Anatomy of the Turkish ID Number
+
+The Turkish Identification Number consists of ```11``` digits.
+
+There are three conditions for a valid identification number:
+
+1. ```d1 > 0```
+2. ```d10 == ((d1 + d3 + d5 + d7 + d9) * 7 - (d2 + d4 + d6 + d8)) mod 10```
+3. ```d11 == (d1 + d2 + d3 + d4 + d5 + d6 + d8 + d9 + d10) mod 10```
+
+Where ```dn``` refers to the ```n-th``` digit of the identification number.
+
+Remember that a valid identification number does not imply the existence of an ID. It could only be used as a preliminary check e.g. before querying a government website. This is very similar to credit card validation.
+
+## Support
+
+This gem is used in production and tested against the following Ruby versions: `ruby-head`, `2.5.1`, `2.4.4`, `2.3.7`, `2.2.10`, `2.1.8`, `1.9.3`. It has no dependencies and will likely work in any Ruby version above `1.9.3`. To make sure there are no breaking changes add it to your Gemfile using the pessimistic operator: `gem 'turkish_id', '~> 0.5.0'`.
+
+
## 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).
@@ -113,11 +111,14 @@
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Bug reports and pull requests are welcome on GitHub at https://github.com/krmbzds/turkish_id.
+## Is it any good?
+Yes.
+
## License
-Copyright © 2015 Kerem Bozdaş
+Copyright © 2015 [Kerem Bozdaş](http://kerembozdas.com/)
This gem is available under the terms of the [MIT License](https://github.com/krmbzds/turkish_id/blob/master/LICENSE.txt).