An open API service indexing awesome lists of open source software.

https://github.com/yous/basehangul-crystal

Human-readable binary encoding, BaseHangul for Crystal
https://github.com/yous/basehangul-crystal

basehangul crystal

Last synced: about 2 months ago
JSON representation

Human-readable binary encoding, BaseHangul for Crystal

Awesome Lists containing this project

README

        

# BaseHangul

[![CI](https://github.com/yous/basehangul-crystal/actions/workflows/ci.yml/badge.svg)](https://github.com/yous/basehangul-crystal/actions/workflows/ci.yml)

Human-readable binary encoding, [BaseHangul](https://basehangul.github.io) for [Crystal](http://crystal-lang.org).

## Installation

1. Add the dependency to your `shard.yml`:

``` yaml
dependencies:
basehangul:
github: yous/basehangul-crystal
```

2. Run `shards install`

## Usage

``` crystal
require "basehangul"
```

``` crystal
BaseHangul.encode("This is an encoded string")
# => "넥라똔먈늴멥갯놓궂뗐밸뮤뉴뗐뀄굡덜멂똑뚤"
```

## 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

## License

Copyright © Chayoung You. See [LICENSE.txt](LICENSE.txt) for further details.