Repository navigation
Lead the README with real life trigger examples - #35
Conversation
- Open with one table of situations per trigger kind and the output they produce. - Move reference material into docs/: dates, usage, configuration, install. - Link every docs page from a short index at the end of the README.
Walkthrough
Merge Risk:
|
- Pull request URLs and #123 for a PR already fire on merge; the README only showed issues.
|
| Project | todo-by |
| Branch | alies-dev/readme |
| Testbed | ubuntu-latest |
Click to view all benchmark results
| Benchmark | Latency | Benchmark Result milliseconds (ms) (Result Δ%) | Upper Boundary milliseconds (ms) (Limit %) |
|---|---|---|---|
| scan angular/angular | 📈 view plot 🚷 view threshold | 135.12 ms(+11.15%)Baseline: 121.57 ms | 151.96 ms (88.92%) |
Context
The README mixed the pitch with reference material: every flag, the config keys, date parsing rules, MSRV notes, and a CI snippet. A visitor had to read about 160 lines to learn what a tag looks like for their situation, and the first examples showed syntax rather than when you would write one.
Solution
The README now opens with one table of real situations, one row per trigger form (day, month, version, strict version,
#123, issue URL, pull request URL), followed by the output those tags produce once they fire and one line on when to use the tool. Install and run are a few lines each, and everything else is linked from a short docs index.Reference material moved to
docs/with no content dropped:docs/dates.md: accepted and rejected date spellings,--warn,--todaydocs/usage.md: all flags, output formats, exit codesdocs/configuration.md:todo-by.tomlkeys and precedencedocs/install.md: Homebrew, Cargo, binaries, the Rust 1.88 floorThe example outputs and the rejected date spellings were checked against the current binary.
Summary by CodeRabbit