From 77009d1112a3dda7576772676db80bc2ec944a95 Mon Sep 17 00:00:00 2001 From: Glenn Date: Fri, 22 Nov 2024 09:52:58 +0100 Subject: [PATCH] doc: add README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..20cdb8b --- /dev/null +++ b/README.md @@ -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" +``` + +