diff --git a/README.md b/README.md index 5b3349fa8db6fabf2e284e729f530a2aa94eaf95..ebe19b68384392c80dc33d32db918accb7c61d6b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # yatd, _yet another td_ -There are many tds. This one is mine. +There are many tds. This one is mine. It's in Rust, very small, very fast, very +simple, uses SQLite embedded in the binary, and includes a skill. I intend it +to be the bare minimum for something like a repo-specific issue tracker and +possibly complementary to tools like [OpenSpec]. + +[OpenSpec]: https://github.com/Fission-AI/OpenSpec + +Install with `mise use -g cargo:https://git.secluded.site/holt@latest` or +`cargo install --git https://git.secluded.site/holt`. Tell your agent how/when +to use td by first installing the skill with `td skill`, then somehow referring +to td when telling the agent to do something involving td. It shouldn't invoke +the skill unless you mention td, allowing your agent to use other todo/issue +tools in other repos even with this global skill. + +Inspired by [alosec/td]. + +[alosec/td]: https://github.com/alosec/td/ ``` $ td --help @@ -24,6 +40,7 @@ Commands: compact Vacuum the database export Export tasks to JSONL (one JSON object per line) import Import tasks from a JSONL file + skill Install the agent skill file (SKILL.md) help Print this message or the help of the given subcommand(s) Options: