Skip to content

Commit 93a6065

Browse files
committed
Updated README to show responses
1 parent 5f4ad82 commit 93a6065

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,34 +42,53 @@ options.
4242

4343
```sh
4444
# Add a daily streak
45-
skidmarks add --name "Exercise" --frequency daily
45+
$ skidmarks add --name "Exercise" --frequency daily
4646

47+
🎉 Created a new daily streak: Exercise
48+
```
49+
50+
```sh
4751
# Add a weekly streak
48-
skidmarks add --name "Read a book" --frequency weekly
52+
$ skidmarks add --name "Read a book" --frequency weekly
53+
54+
🎉 Created a new weekly streak: Read a book
4955
```
5056

5157
### Listing All Streaks
5258

5359
To list all existing streaks, use the `list` command.
5460

5561
```sh
56-
skidmarks list
62+
$ skidmarks list
63+
64+
| Streak | Freq | Status | Last Check In | Total
65+
---+-----------------+--------+--------+---------------+-------
66+
0 | Exercise | daily || 2024-07-31 | 1
67+
1 | Wordle | daily || 2024-07-31 | 1
68+
2 | Coloring page | daily || 2024-07-31 | 1
69+
3 | Duolingo | daily || 2024-07-31 | 1
70+
4 | Animal Crossing | daily || None | 0
71+
5 | Read a book | weekly || None | 0
5772
```
5873

5974
### Checking In on a Streak
6075

61-
To check in on a streak, use the `check-in` command.
76+
To check in on a streak, use the `check-in <streak id>` command.
6277

6378
```sh
64-
skidmarks check-in <streak_id>
79+
$ skidmarks check-in 0
80+
81+
🌟 Checked in on the "Exercise" streak!
6582
```
6683

6784
### Removing a Streak
6885

69-
To remove a streak, use the `remove` command.
86+
To remove a streak, use the `remove <streak id>` command.
7087

7188
```sh
72-
skidmarks remove <streak_id>
89+
$ skidmarks remove 5
90+
91+
🗑 Removed the "Read a book" streak
7392
```
7493

7594
## Running Tests

0 commit comments

Comments
 (0)