Skip to content

Commit

Permalink
doc: Rework the expected CLI output
Browse files Browse the repository at this point in the history
  • Loading branch information
ducdetronquito committed Jan 1, 2024
1 parent 199921b commit b8940cf
Showing 1 changed file with 37 additions and 9 deletions.
46 changes: 37 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,59 @@ $ birthday add "Anita Bath" 22/09/1987

# Show all birthdays
$ birthday all
Ben Dover 03/05/1990 34yo
Hugh Jarse 10/12/1995 39yo
Anita Bath 22/09/1987 37yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may | 34 (1990) │ today │
│ 3 │ Anita Bath │ 22 september │ 37 (1987) │ 142 days │
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Show the next birthday
$ birthday next
Hugh Jarse 10/12/1995 39yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Show today's birthdays
$ birthday today
Ben Dover 03/05/1990 34yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may | 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Get all birthdays where the name match "Ben"
$ birthday search --name Ben
Ben Dover 03/05/1990 34yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may | 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Get all birthdays for a specific year
$ birthday search --year 1987
Anita Bath 22/09/1987 37yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 3 │ Anita Bath │ 22 september │ 37 (1987) │ 142 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Get all birthdays for a specific month
$ birthday search --month 12
Hugh Jarse 10/12/1995 39yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 2 │ Hugh Jarse │ 10 december │ 29 (1995) │ 221 days │
╰────┴────────────┴──────────────┴───────────┴───────────────╯

# Get all birthdays for a specific day
$ birthday search --month 3
Ben Dover 03/05/1990 34yo
╭────┬────────────┬──────────────┬───────────┬───────────────╮
│ Id │ Name │ Birthday │ Age │ Next birthday │
├────┼────────────┼──────────────┼───────────┼───────────────┤
│ 1 │ Ben Dover │ 3 may | 34 (1990) │ today │
╰────┴────────────┴──────────────┴───────────┴───────────────╯
```

0 comments on commit b8940cf

Please sign in to comment.