docs: update readme and link to documentation where applicable

Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
pace-rs · Mar 11, 2024 · 771505e · 771505e
1 parent cc709d4
commit 771505e
Showing 1 changed file with 15 additions and 185 deletions.
diff --git a/README.md b/README.md
@@ -47,200 +47,30 @@ You can ask questions in the
 | Discord       | [![Discord](https://dcbadge.vercel.app/api/server/RKSWrAcYdG?style=flat-square)](https://discord.gg/RKSWrAcYdG) |
 | Discussions   | [GitHub Discussions](https://github.com/orgs/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
 
-### From binaries
-
-#### [cargo-binstall](https://crates.io/crates/cargo-binstall)
-
-```bash
-cargo binstall pace-rs
-```
-
-#### Windows
-
-##### [Scoop](https://scoop.sh/)
-
-<!-- TODO!: When official
- ```bash
-scoop install pace
-``` -->
-
-```bash
-scoop bucket add pace https://github.com/pace-rs/pace/
-scoop install pace
-```
-
-#### MacOS
-
-##### [Homebrew](https://brew.sh/)
-
-You can use our tap:
-
-```bash
-brew install pace-rs/homebrew-tap/pace-rs
-```
-
-<!--
-#### npm
-
-TODO!: Check if needed and how easy it is supported with cargo-dist
--->
-
-#### From GitHub
+Help for installing `pace` can be found in the
+[installation instructions](https://pace.cli.rs/docs/installation.html).
 
-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 --locked
-```
-
-### crates.io
+## Getting started
 
-```bash
-cargo install pace-rs --locked
-```
+Please check our
+[getting started guide](https://pace.cli.rs/docs/user_guide/getting_started.html)
+for more information on how to get started right afterwards. You can also run
+`pace docs` to open the documentation in your browser.
 
 ## Usage
 
-### Key
-
-✅ = fully functioning
-
-🔍 = review and testing in progress
-
-🪧 = implemented, more testing needed
-
-⏲️ = work in progress
-
-📜 = design stage
-
-❌ = not implemented, yet
-
-💡 = idea
-
-### Commands
-
-**Note:** The following commands are subject to change as the project develops.
-Currently they are stating the intended functionality and may not be fully
-implemented yet (e.g. using activities instead of tasks).
-
-✅ **`pace setup`**
-
-- **Description:** Create 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 setup config` or `pace setup completions`
-
-✅ **`pace adjust`**
-
-- **Description:** Adjust the current activity's start time, description,
-  category, or tags. This is useful for correcting mistakes or adding more
-  detail to your activities.
-- **Usage:**
-  `pace adjust --category <Category> --description <Description> --start <Start Time>`
-
-✅ **`pace begin`**
-
-- **Description:** Starts tracking time for the specified task. You can
-  optionally specify a category or project to help organize your tasks.
-- **Usage:** `pace begin "Design Work" --category "Freelance" --start 10:00`
-
-✅ **`pace end`**
-
-- **Description:** Stops time tracking for the specified task, marking it as
-  completed or finished for the day.
-- **Usage:** `pace end --end 11:30 --only-last`
-
-✅ **`pace docs`**
-
-- **Description:** Opens the (dev-)documentation in your default browser.
-- **Usage:** `pace docs` or `pace docs --dev`
-
-✅ **`pace now`**
-
-- **Description:** Displays the currently running task, showing you at a glance
-  what you're currently tracking.
-- **Usage:** `pace now`
-
-✅ **`pace hold`**
-
-- **Description:** Pauses the time tracking for the specified task. This is
-  useful for taking breaks without ending the task.
-- **Usage:** `pace hold --reason <Reason>`
-
-✅ **`pace resume`**
-
-- **Description:** Resumes time tracking for a previously paused task, allowing
-  you to continue where you left off.
-- **Usage:** `pace resume` or `pace resume --list`
-
-🔍 **`pace review`**
-
-- **Description:** Gain insight in your activities and tasks. You can specify
-  the time frame for daily, weekly, or monthly insights.
-
-  **⚠️ NOTE**: This command is currently in review and testing. Some features may
-  not be fully implemented yet.
-- **Usage:** `pace review --last-week` or
-  `pace review --from 2024-02-10 --to 2024-03-06` or
-  `pace review --today -o json -e ./data/data.json`
-
-✅ **`pace help`**
-
-- **Description:** Displays help information, offering quick access to command
-  usage and options.
-- **Usage:** `pace help`, `pace <command> --help`, or `pace help <command>`
-
-<details>
-  <summary>Some Ideas For Additional Useful Commands</summary>
-
-**Note:** These commands are not yet implemented and are subject change to
-during their design process.
-
-💡 **`pace export --json/--csv`**
-
-- **Description:** Exports your tracked data and insights in JSON or CSV format,
-  suitable for analysis or record-keeping.
-- **Usage:** `pace export --csv --from 2021-01-01 --to 2021-01-31`
-
-💡 **`pace tasks`**
-
-- **Description:** Lists all tasks with optional filters. Use this to view
-  active, completed, or today's tasks.
-- **Usage:** `pace tasks --active`
-
-💡 **`pace projects`**
-
-- **Description:** Lists all projects with optional filters. Use this to view
-  all projects, subprojects and their associated tasks.
-- **Usage:** `pace projects`
-
-💡 **`pace pomo`**
-
-- **Description:** Starts a Pomodoro session for the specified task, integrating
-  the Pomodoro technique directly with your tasks.
-- **Usage:** `pace pomo "Study Session"`
-
-💡 **`pace set`**
+For usage examples for various commands please check the
+[usage examples](https://pace.cli.rs/docs/user_guide/usage_examples.html).
 
-- **Description:** Sets various application configurations, including Pomodoro
-  lengths and preferred review formats.
-- **Usage:** `pace set --work 25 --break 5`
+## FAQ / FATQ
 
-</details>
+Please check our [FAQ](https://pace.cli.rs/docs/user_guide/FAQ.html) for
+frequently asked questions. If you have a question that is not answered there,
+please open an issue or ask in the discussions. We will be happy to help you. If
+your are more interested in the development of `pace`, please check our
+[FATQ](https://pace.cli.rs/dev-docs/appendix/FATQ.html).
 
 ## Contributing