Skip to content

Commit

Permalink
doc: Document data location
Browse files Browse the repository at this point in the history
  • Loading branch information
ducdetronquito committed Jan 14, 2024
1 parent 0ee4e2d commit 7654ff5
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7654ff5

Please sign in to comment.