Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
kennethlove committed Aug 20, 2024
1 parent b2e4698 commit 44c47b6
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

Skidmarks is a command-line application written in Rust for managing streaks.
It allows users to add and list streaks with different frequencies (daily or
weekly).
weekly) adn check in to those streaks to maintain them.

## Features

- Add new streaks with a specified name and frequency.
- List all existing streaks.
- Check in on a streak to keep it going.
- Remove a streak when it's no longer needed.
- CLI, TUI, and GUI interfaces available.

## Installation

Expand Down Expand Up @@ -71,6 +72,24 @@ $ skidmarks list
5 | Read a book | weekly || None | 0
```

#### Filtering Streaks

You can filter the list of streaks by using the `--done`, `--waiting`, or `--missed` flags.

You can filter by frequency with the `--frequency [daily, weekly]` argument.

#### Searching Streaks

You can search the list of streaks by using the `--search` flag.

```sh
$ skidmarks list --search "Exercise"

| Streak | Freq | Status | Last Check In | Total
---+-----------------+--------+--------+---------------+-------
0 | Exercise | daily || 2024-07-31 | 1
```

### Checking In on a Streak

To check in on a streak, use the `check-in <streak id>` command.
Expand All @@ -91,6 +110,22 @@ $ skidmarks remove 5
🗑 Removed the "Read a book" streak
```

## TUI

There is a TUI interface available for Skidmarks. To use it, run the following:

```shell
skidmarks tui
```

## GUI

There is a GUI interface available for Skidmarks. To use it, run the following:

```shell
skidmarks gui
```

## Running Tests

To run the tests for this project, use the following command:
Expand Down

0 comments on commit 44c47b6

Please sign in to comment.