Skip to content

Commit

Permalink
doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Adamska1008 committed Sep 12, 2024
1 parent 0f28b97 commit f56b504
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# today

Use **today** to review what you've done today! - In the future. Today is under construction now.

![Static Badge](https://img.shields.io/badge/C%2B%2B-17-blue) ![GitHub License](https://img.shields.io/github/license/Adamska1008/today)

Today is a lightweight tool for tracking daily code commits, allowing developers to easily review the number of commits, lines changed and files modified each day.

## Usage

### Counting everyday commit

By default **today** shows your commit today. Without specified `--author` every commit is counted.

```bash
Use today to review what you have accomplished today!
Use today to review what you've accomplished today!
Usage:
today [OPTION...]
-o, --offset arg Offset from today (default: 0)
-d, --directory arg The working directory to be check (default: .)
-h, --help Print usage
```
Expand Down Expand Up @@ -42,6 +43,12 @@ Total: Commits 5, Lines Added 118, Lines Removed 9, Files Changed 6.
+=========+======================================+======================+=============+===============+===============+
```
Use `offset` options to check your commit yesterday or before yesterday.
```sh
today --offset=-1 # generally only negative number works, you can't predict the future
```

## Setup

### Build from source
Expand Down

0 comments on commit f56b504

Please sign in to comment.