https://github.com/singond/crystal-dict

Crystal implementation of the DICT protocol
https://github.com/singond/crystal-dict

Last synced: 10 days ago
JSON representation

Crystal implementation of the DICT protocol

• Host: GitHub
• URL: https://github.com/singond/crystal-dict
• Owner: Singond
• Created: 2023-07-31T19:22:05.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-03T10:25:09.000Z (about 1 year ago)
• Last Synced: 2024-11-06T20:42:14.237Z (about 2 months ago)
• Language: Crystal
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DICT protocol

Crystal implementation of the DICT protocol

([RFC 2229](https://www.rfc-editor.org/rfc/rfc2229)).

## Installation

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

```yaml

dependencies:

  dict-protocol:

    github: singond/dict-protocol

```

2. Run `shards install`

## Usage

```crystal

require "dict-protocol"

```

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

### Running tests

The tests use the `Log` class to log messages.

To see the messages, set the `LOG_LEVEL` environment variable:

```

LOG_LEVEL=info crystal spec

```

## Contributors

- [Jan Singon Slany](https://github.com/singond) - creator and maintainer