Added README changes to show install steps

This commit is contained in:
Tristan Ancelet
2026-03-31 10:26:33 -05:00
parent 613e059fb7
commit 3217750714

View File

@@ -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