diff --git a/README.md b/README.md index 314b81a..40b4f0b 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,18 @@ CLI tool to remember birthdays of people you know +## Installation + +```shell +cargo install birthday +``` + ## Usage +Birthdays are stored in a SQLite database located in the [standard data directory](https://dirs.dev/) +of your OS, but you can also override this behavior by defining a custom path via the `BIRTHDAY_DATA` environment variable. + + ```shell # Add someone's birthday $ birthday add "Ben Dover" 03/05/1990