diff --git a/taskchampion/README.md b/README.md similarity index 74% rename from taskchampion/README.md rename to README.md index 1a33e6b87..3a65a287f 100644 --- a/taskchampion/README.md +++ b/README.md @@ -5,7 +5,7 @@ TaskChampion is an open-source personal task-tracking application. Use it to keep track of what you need to do, with a quick command-line interface and flexible sorting and filtering. It is modeled on [TaskWarrior](https://taskwarrior.org), but not a drop-in replacement for that application. -Goals: +## Goals * Feature parity with TaskWarrior (but not compatibility) * Aproachable, maintainable codebase @@ -14,7 +14,15 @@ Goals: * Reliable concurrency - clients do not diverge * Storage performance O(n) with n number of tasks -See: +## Structure + +There are three crates here: + + * [taskchampion](./taskchampion) - the core of the tool + * [taskchampion-cli](./cli) - the command-line binary + * [taskchampion-sync-server](./sync-server) - the server against which `task sync` operates + +## See Also * [Documentation](docs/src/SUMMARY.md) (will be published as an mdbook eventually) * [Progress on the first version](https://github.com/djmitche/taskwarrior-rust/projects/1)