Skidmarks

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).

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.

Installation

To install Skidmarks, you need to have Rust and Cargo installed on your system. You can install Rust using rustup.

# Clone the repository
git clone https://github.com/kennethlove/skidmarks.git

# Navigate to the project directory
cd skidmarks

# Build the project
cargo build --release

Usage

Adding a Streak

To add a new streak, use the add command with the --name and --frequency options.

# Add a daily streak
./target/release/skidmarks add --name "Exercise" --frequency daily

# Add a weekly streak
./target/release/skidmarks add --name "Read a book" --frequency weekly

Listing All Streaks

To list all existing streaks, use the list command.

./target/release/skidmarks list

Checking In on a Streak

To check in on a streak, use the check-in command.

./target/release/skidmarks check-in <streak_id>

Removing a Streak

To remove a streak, use the remove command.

./target/release/skidmarks remove <streak_id>

Running Tests

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

cargo test

Example

Here is an example of how to use Skidmarks:

# Add a daily streak
./target/release/skidmarks add --name "Test Streak" --frequency daily

# Add a weekly streak
./target/release/skidmarks add --name "Test Streak" --frequency weekly

# List all streaks
./target/release/skidmarks list

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

This project is licensed under the Apache License. See the LICENSE file for details.