Add install instructions to the ReADME

lipanski · Dec 27, 2017 · 4f7ae8b · 4f7ae8b
1 parent ce530e5
commit 4f7ae8b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,18 @@ A Keepass KDBX v2/v3 parser for Crystal.
 
 This library requires **libsodium**. On Ubuntu 17.04 you can install it via `sudo apt install libsodium-dev`. For other distros, please check [the libsodium docs](https://download.libsodium.org/doc/).
 
+## Install
+
+Add the following lines to your `shard.yml`:
+
+```yaml
+dependencies:
+  keepass:
+    github: lipanski/keepass
+```
+
+...and run `crystal deps` or `shards install`.
+
 ## Usage
 
 ```crystal