doc: add README

This commit is contained in:
Glenn Y. Rolland 2024-11-22 09:52:58 +01:00
parent dcb83b5aba
commit 77009d1112

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# Which for Crystal
FIXME: description
## Features
## Installation
Add it to your shard.yml:
```yaml
dependencies:
redis:
github: glenux/which
```
and then install the library into your project:
```shell-session
$ shards install
```
## Required Crystal Version
This library needs Crystal version >= 0.34.0
I haven't tested older Crystal versions.
## Usage
Require the package:
```crystal
require "which"
```