Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
timonv committed May 24, 2024
1 parent 1067304 commit 608bb21
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ TODO comments in code have a tendency to be just left there yet they also have t

![image](https://github.com/timonv/todors/assets/49373/226d6307-4dc4-46f1-9806-e3741f728996)


## Installation

Manual:
Expand All @@ -18,26 +17,37 @@ Manual:
Via cargo:
`cargo install dowhatagain`

## Features

- Output in Markdown and plain text
- Group by filename
- Simple display or detailed with filename and line number
- Way faster than needed using buffered parallel processing

## Example usage

Get all TODOs in a repository:
`fd . | dowhatagain`

Output:

```
// File: main.rs
TODO: Do thing
// File: other.rs
TODO: Other thing
$ fd . | dowhatagain
file1.rs:3: Do thing
file2.rs:4: Other thing
```

Get all TODOs for the current changeset and output to markdown:
`git diff master --name-only | dowhatagain --output markdown`
`git diff master --name-only | dowhatagain --output markdown --group-by file --detail just-task`

```markdown
- [ ] file.rs:3 Do thing
- [ ] other_file.rs:4 Do other thing
file.rs

- [ ] Do thing
- [ ] Do other thing

other_file.rs

- [ ] Do thing
- [ ] Do other thing
```

Great for PR checks, commit hooks and custom workflows.

0 comments on commit 608bb21

Please sign in to comment.