https://github.com/tijn/koremutake
an implementation of the koremutake algorithm in Crystal
https://github.com/tijn/koremutake
Last synced: 8 months ago
JSON representation
an implementation of the koremutake algorithm in Crystal
- Host: GitHub
- URL: https://github.com/tijn/koremutake
- Owner: tijn
- License: mit
- Created: 2019-11-10T21:14:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T22:06:51.000Z (over 3 years ago)
- Last Synced: 2025-01-03T15:12:10.334Z (over 1 year ago)
- Language: Crystal
- Size: 3.91 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koremutake
* A Crystal library with the koremutake algorithm.
* Convert numbers to words that (supposedly) are easier to remember and compare.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
koremutake:
github: tijn/koremutake
```
2. Run `shards install`
## Usage
```crystal
require "koremutake"
string = Koremutake.encode(0) # => "Ba"
Koremutake.encode(10610353957) # => "Koremutake"
Koremutake.decode(string) # => 0
```
## Development
TODO: Write development instructions here
## 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 a new Pull Request
## Contributors
- [Tijn Schuurmans](https://github.com/tijn) - creator and maintainer