docs: update readmes

Signed-off-by: simonsan <[email protected]>
pace-rs · Feb 14, 2024 · b97956f · b97956f
1 parent 7164f8f
commit b97956f
Show file tree

Hide file tree

Showing 3 changed files with 259 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,76 @@
 <a href="https://crates.io/crates/pace-rs"><img src="https://img.shields.io/crates/d/pace-rs.svg" /></a>
 <p>
 
-## Command Overview
+## About
+
+`pace` is a mindful productivity tool designed to help you keep track of your
+activities with ease and intention.
+
+Born from the desire to blend simplicity with effectiveness, pace offers a
+command-line interface (CLI) that encourages focused work sessions, thoughtful
+reflection on task durations, and a harmonious balance between work and rest.
+
+Whether you're a developer, a writer, or anyone who values structured time
+management, pace provides the framework to log activities, review progress, and
+optimize how you spend your time.
+
+With features like the first activity wizard for onboarding new users, real-time
+configuration validation (upcoming), and personalized activity logs, pace is
+more than a time tracker — it's your partner in crafting a productive and
+mindful routine.
+
+## Contact
+
+You can ask questions in the
+[Discussions](https://github.com/pace-rs/pace/discussions) or have a look at the
+[FAQ](https://pace.cli.rs/docs/FAQ.html).
+
+| Contact       | Where?                                                             |
+| ------------- | ------------------------------------------------------------------ |
+| Issue Tracker | [GitHub Issues](https://github.com/pace-rs/pace/issues/new/choose) |
+| Discussions   | [GitHub Discussions](https://github.com/pace-rs/discussions)       |
+
+## Getting started
+
+Please check our [documentation](https://pace.cli.rs/docs/getting_started.html)
+for more information on how to get started.
+
+## Installation
+
+<!-- TODO! ### From binaries
+
+#### [cargo-binstall](https://crates.io/crates/cargo-binstall)
+
+```bash
+cargo binstall pace-rs
+``` -->
+
+<!-- TODO! #### Windows
+
+##### [Scoop](https://scoop.sh/)
+
+```bash
+scoop install pace
+``` -->
+
+Check out the [releases](https://github.com/pace-rs/pace/releases).
+
+### From source
+
+**Beware**: This installs the latest development version, which might be
+unstable.
+
+```bash
+cargo install --git https://github.com/pace-rs/pace.git pace-rs
+```
+
+### crates.io
+
+```bash
+cargo install pace-rs
+```
+
+## Usage
 
 ### Key
 
@@ -28,10 +97,14 @@
 Currently they are stating the intended functionality and may not be fully
 implemented yet (e.g. using activities instead of tasks).
 
-⏲️ **`pace craft`**
+🪧 **`pace craft`**
 
-- **Description:** Cr
-- **Usage:** `pace begin "Design Work" --category "Freelance" --time 10:00`
+- **Description:** Craft configuration files for pace, including the main
+  configuration file and any additional settings. This is useful for setting up
+  pace for the first time or when you need to change your settings. You can also
+  generate shell completions for your shell of choice. And generate a project
+  configuration file.
+- **Usage:** `pace craft setup`
 
 🪧 **`pace begin`**
 
@@ -107,6 +180,31 @@ implemented yet (e.g. using activities instead of tasks).
   lengths and preferred review formats.
 - **Usage:** `pace set --work 25 --break 5`
 
+## Contributing
+
+Found a bug? [Open an issue!](https://github.com/pace-rs/pace/issues/new/choose)
+
+Got an idea for an improvement? Don't keep it to yourself!
+
+- [Contribute fixes](https://github.com/pace-rs/pace/contribute) or new features
+  via a pull requests!
+
+Please make sure, that you read the
+[contribution guide](https://pace.cli.rs/docs/contributing-to-pace.html).
+
+## Minimum Rust version policy
+
+This crate's minimum supported `rustc` version is `1.74.1`.
+
+The current policy is that the minimum Rust version required to use this crate
+can be increased in minor version updates. For example, if `crate 1.0` requires
+Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
+1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
+version of Rust.
+
+In general, this crate will be conservative with respect to the minimum
+supported version of Rust.
+
 ## License
 
 **AGPL-3.0-or-later**; see [LICENSE](./LICENSE).
diff --git a/crates/cli/README.md b/crates/cli/README.md
@@ -0,0 +1,76 @@
+<p align="center">
+<img src="https://raw.githubusercontent.com/pace-rs/assets/main/logos/readme_header_cli.png" height="350" />
+</p>
+<p align="center"><b>pace-cli - library to support timetracking on the command line</b></p>
+
+<p align="center">
+<a href="https://crates.io/crates/pace_cli"><img src="https://img.shields.io/crates/v/pace_cli.svg" /></a>
+<a href="https://docs.rs/pace_cli/"><img src="https://img.shields.io/docsrs/pace_cli?style=flat&amp;labelColor=1c1d42&amp;color=4f396a&amp;logo=Rust&amp;logoColor=white" /></a>
+<a href="https://raw.githubusercontent.com/pace-rs/pace/main/crates/cli/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3+-red.svg" /></a>
+<a href="https://crates.io/crates/pace_cli"><img src="https://img.shields.io/crates/d/pace_cli.svg" /></a>
+<p>
+
+## About
+
+`pace-cli` is a library to support timetracking on the command line. It is the
+library to support special cli use cases for the `pace` timetracking
+application.
+
+## Contact
+
+You can ask questions in the
+[Discussions](https://github.com/pace-rs/pace/discussions) or have a look at the
+[FAQ](https://pace.cli.rs/docs/FAQ.html).
+
+| Contact       | Where?                                                             |
+| ------------- | ------------------------------------------------------------------ |
+| Issue Tracker | [GitHub Issues](https://github.com/pace-rs/pace/issues/new/choose) |
+| Discussions   | [GitHub Discussions](https://github.com/pace-rs/discussions)       |
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+pace_cli = "0.4"
+```
+
+or use
+
+```console
+cargo add pace_cli
+```
+
+## Examples
+
+TODO!
+
+## Contributing
+
+Found a bug? [Open an issue!](https://github.com/pace-rs/pace/issues/new/choose)
+
+Got an idea for an improvement? Don't keep it to yourself!
+
+- [Contribute fixes](https://github.com/pace-rs/pace/contribute) or new features
+  via a pull requests!
+
+Please make sure, that you read the
+[contribution guide](https://pace.cli.rs/docs/contributing-to-pace.html).
+
+## Minimum Rust version policy
+
+This crate's minimum supported `rustc` version is `1.74.1`.
+
+The current policy is that the minimum Rust version required to use this crate
+can be increased in minor version updates. For example, if `crate 1.0` requires
+Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
+1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
+version of Rust.
+
+In general, this crate will be conservative with respect to the minimum
+supported version of Rust.
+
+## License
+
+**AGPL-3.0-or-later**; see [LICENSE](./LICENSE).
diff --git a/crates/core/README.md b/crates/core/README.md
@@ -0,0 +1,81 @@
+<p align="center">
+<img src="https://raw.githubusercontent.com/pace-rs/assets/main/logos/readme_header_core.png" height="350" />
+</p>
+<p align="center"><b>pace-core - library to support timetracking on the command line</b></p>
+
+<p align="center">
+<a href="https://crates.io/crates/pace_core"><img src="https://img.shields.io/crates/v/pace_core.svg" /></a>
+<a href="https://docs.rs/pace_core/"><img src="https://img.shields.io/docsrs/pace_core?style=flat&amp;labelColor=1c1d42&amp;color=4f396a&amp;logo=Rust&amp;logoColor=white" /></a>
+<a href="https://raw.githubusercontent.com/pace-rs/pace/main/crates/core/LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3+-red.svg" /></a>
+<a href="https://crates.io/crates/pace_core"><img src="https://img.shields.io/crates/d/pace_core.svg" /></a>
+<p>
+
+## About
+
+`pace-core` is a library to support timetracking on the command line. It is the
+core library for the `pace` timetracking application.
+
+## Contact
+
+You can ask questions in the
+[Discussions](https://github.com/pace-rs/pace/discussions) or have a look at the
+[FAQ](https://pace.cli.rs/docs/FAQ.html).
+
+| Contact       | Where?                                                             |
+| ------------- | ------------------------------------------------------------------ |
+| Issue Tracker | [GitHub Issues](https://github.com/pace-rs/pace/issues/new/choose) |
+| Discussions   | [GitHub Discussions](https://github.com/pace-rs/discussions)       |
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+pace_core = "0.4"
+```
+
+or use
+
+```console
+cargo add pace_core
+```
+
+## Features
+
+- **Time Tracking**: Track your time on the command line.
+- **Simple**: Easy to use and understand.
+- **Fast**: Written in Rust, `pace-core` is fast and efficient
+
+## Examples
+
+TODO!
+
+## Contributing
+
+Found a bug? [Open an issue!](https://github.com/pace-rs/pace/issues/new/choose)
+
+Got an idea for an improvement? Don't keep it to yourself!
+
+- [Contribute fixes](https://github.com/pace-rs/pace/contribute) or new features
+  via a pull requests!
+
+Please make sure, that you read the
+[contribution guide](https://pace.cli.rs/docs/contributing-to-pace.html).
+
+## Minimum Rust version policy
+
+This crate's minimum supported `rustc` version is `1.74.1`.
+
+The current policy is that the minimum Rust version required to use this crate
+can be increased in minor version updates. For example, if `crate 1.0` requires
+Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust
+1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum
+version of Rust.
+
+In general, this crate will be conservative with respect to the minimum
+supported version of Rust.
+
+## License
+
+**AGPL-3.0-or-later**; see [LICENSE](./LICENSE).