@@ -42,34 +42,53 @@ options.
42
42
43
43
``` sh
44
44
# Add a daily streak
45
- skidmarks add --name " Exercise" --frequency daily
45
+ $ skidmarks add --name " Exercise" --frequency daily
46
46
47
+ 🎉 Created a new daily streak: Exercise
48
+ ```
49
+
50
+ ``` sh
47
51
# 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
49
55
```
50
56
51
57
### Listing All Streaks
52
58
53
59
To list all existing streaks, use the ` list ` command.
54
60
55
61
``` 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
57
72
```
58
73
59
74
### Checking In on a Streak
60
75
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.
62
77
63
78
``` sh
64
- skidmarks check-in < streak_id>
79
+ $ skidmarks check-in 0
80
+
81
+ 🌟 Checked in on the " Exercise" streak!
65
82
```
66
83
67
84
### Removing a Streak
68
85
69
- To remove a streak, use the ` remove ` command.
86
+ To remove a streak, use the ` remove <streak id> ` command.
70
87
71
88
``` sh
72
- skidmarks remove < streak_id>
89
+ $ skidmarks remove 5
90
+
91
+ 🗑 Removed the " Read a book" streak
73
92
```
74
93
75
94
## Running Tests
0 commit comments