diff --git a/README.md b/README.md index 3a56270..6021a99 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,19 @@ This is a crystal project to manage setting up OptionParser objects based around "Command" objects and arguments you define inside them. +## Installation + +1. Add the dependency to your `shard.yml`: + + ```yaml + dependencies: + cligen: + git: https://git.arcanium.tech/tristan/cligen + ``` + +2. Run `shards install` + + ## Usage ```crystal require "cligen" @@ -9,4 +22,4 @@ require "cligen" ## Contributors -- [Tristan Ancelet](https://github.com/your-github-user) - creator and maintainer +- [Tristan Ancelet](https://git.arcanium.tech/tristan) - creator and maintainer