From 4f7ae8bc9549767c18eb7293e1d2a61850595347 Mon Sep 17 00:00:00 2001 From: Florin Lipan Date: Wed, 27 Dec 2017 01:27:55 +0100 Subject: [PATCH] Add install instructions to the ReADME --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 487a2e7..d0ea141 100644 --- 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