Sha256: bd9282c54edbfe1b8ebbb98f033f52c6ece72ee1bd5465d72f88f20a3186e88b

Contents?: true

Size: 977 Bytes

Versions: 1

Compression:

Stored size: 977 Bytes

Contents

# Dixon

[Frank] Dixon checks your ID number.

Now only supports identification number for Taiwan, more are coming up.

## Requirements

Ruby 2.0+

## Installation

    $ gem install dixon

## API

Provides three instance methods: `checks`, `gender`, and `issued_by`.

* `checks` checks if given ID is a valid Taiwan identification number.

* `gender` returns gender of given ID.

* `issued_by` returns which local agencies issued this ID.

## Usage

    Dixon::Validators::Taiwan.new.checks 'A123456789'
    => true

    Dixon::Validators::Taiwan.new.gender 'A123456789'
    => "male"

    Dixon::Validators::Taiwan.new.issued_by 'A123456789'
    => "Taipei City"

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## TODO

* add tests.

## Author

Juanito Fatas

## License

MIT License

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
dixon-0.0.1 README.md