Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tdegrunt/zbase32
ZBase32 - encoding designed to be easier for human use and more compact
https://github.com/tdegrunt/zbase32
encoding ruby rubygem zbase32
Last synced: 26 days ago
JSON representation
ZBase32 - encoding designed to be easier for human use and more compact
- Host: GitHub
- URL: https://github.com/tdegrunt/zbase32
- Owner: tdegrunt
- License: mit
- Created: 2019-09-23T21:34:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-28T20:02:42.000Z (about 5 years ago)
- Last Synced: 2024-08-09T23:06:56.774Z (3 months ago)
- Topics: encoding, ruby, rubygem, zbase32
- Language: Ruby
- Homepage:
- Size: 12.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Zbase32
Base32 encoding designed to be easier for human use and more compact.
For more information, see [Wikipedia](https://en.wikipedia.org/wiki/Base32#z-base-32)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'zbase32'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install zbase32
## Usage
```ruby
hash = ZBase32.encode('test')
result = ZBase32.decode(hash)
```
## 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/tdegrunt/zbase32. 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 Zbase32 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zbase32/blob/master/CODE_OF_CONDUCT.md).