docs: Tidy up the docs (#230)

Signed-off-by: Shigure Kurosaki <shigure@hqsy.net>

README.md

@@ -20,36 +20,12 @@
 
 ![demo](https://raw.githubusercontent.com/kurosakishigure/katharsis/refs/heads/canary/assets/demo.gif)
 
-## How to use
-
-Go to [USE.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/USE.md) to read about how to use Katharsis.
-
-## Installing from Source
-
-If you need to build this project from scratch, please refer to the [INSTALL.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/INSTALL.md).
-
-## Documentation
-
-You can run the `cargo doc --open` command in the root directory of the project to open the web documentation in your browser.
-
-## Contributing
-
-See [CONTRIBUTING.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/CONTRIBUTING.md).
-
-## Security
-
-We firmly believe that no software is completely secure, and we welcome contributions from security researchers.
-
-See [SECURITY.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/SECURITY.md).
-
-## FAQ
-
-See [FAQ.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/FAQ.md).
-
-## Notice
-
-See [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSES/NOTICE).
-
-## License
-
-Katharsis is primarily distributed under the terms of the MIT License. For more details, please refer to the [LICENSE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSE).
+## Contents
+
+- [INSTALL.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/INSTALL.md)
+- [USE.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/USE.md)
+- [FAQ.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/FAQ.md)
+- [CONTRIBUTING.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/CONTRIBUTING.md)
+- [SECURITY.md](https://github.com/kurosakishigure/katharsis/blob/canary/.github/SECURITY.md)
+- [NOTICE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSES/NOTICE)
+- [LICENSE](https://github.com/kurosakishigure/katharsis/blob/canary/LICENSE)

docs/FAQ.md

@@ -8,8 +8,6 @@ When you first run Katharsis on macOS, you might see a system security warning t
 
 This happens because the Katharsis binary was not signed with an [Apple Developer Certificate](https://developer.apple.com/support/certificates) during its build process in the [Actions](https://github.com/kurosakishigure/katharsis/actions/workflows/cd.yml).
 
-> We plan to use artifact attestations to establish provenance for builds. For more details, see [#73](https://github.com/kurosakishigure/katharsis/issues/73).
-
 ### Plan 1
 
 You can use the following operations:
@@ -18,12 +16,4 @@ You can use the following operations:
 
 ### Plan 2
 
-You can refer to the **Cargo** section in [USE.md](https://github.com/kurosakishigure/katharsis/blob/canary/docs/USE.md#linux-and-macos) to install Katharsis.  
-
-> Please **ensure** that the Cargo package manager is installed.
-
-### Plan 3
-
-If you prefer, you can also choose to install from source. For detailed instructions, please refer to [INSTALL.md](INSTALL.md).
-
-> In the future, we plan to address this problem by enabling installation of Katharsis through package managers like [brew](https://brew.sh). If you're interested in helping us implement this feature, you can contribute by following the guidelines in [CONTRIBUTING.md](../.github/CONTRIBUTING.md).
+Do not use the [Manual](https://github.com/kurosakishigure/katharsis/blob/canary/docs/INSTALL.md#manual) installation method.

docs/INSTALL.md

@@ -1,43 +1,46 @@
-# Installing from Source
+# Installation
 
-## Ensure Rust Toolchain is Installed
+## Package Managers
 
-First, make sure that you have the Rust toolchain installed.
-
-> If you haven’t installed it yet, visit the [official Rust website](https://www.rust-lang.org) and follow the instructions to install Rust and Cargo.
-
-You can check if Rust and Cargo are installed by running:
+### Cargo
 
 ```bash
-rustc --version
-cargo --version
+cargo binstall katharsis
+# or
+cargo binstall katharsis@1.0.0-canary.24
 ```
 
-> You should see version information if they are properly installed.
+### Paru
 
-## Navigate to the Project Directory
+```bash
+paru -S katharsis
+```
 
-Open a terminal and navigate to the root directory of the Katharsis project you [cloned](https://github.com/git-guides/git-clone) from GitHub.
+### Apt
 
 ```bash
-cd /path/to/your/katharsis/project
+sudo apt install ~/your/download/path/katharsis.deb
 ```
 
-## Install and Build the Project
-
-To install the dependencies specified in the `Cargo.toml` file, run the following command:
+## Manual
 
 ```bash
-cargo build --release
+# Extract the tarball
+tar -xzf ~/your/download/path/katharsis.tar.gz
+
+# Move the binary to the appropriate directory
+mv ~/your/extract/path/katharsis /usr/local/bin
 ```
 
-> - This command not only installs the dependencies but also builds the project.
-> - You can run the `cd target/release` command in the root directory of the project to find the katharsis executable file in the release folder.
+## Source
 
-## Run Unit Tests (optional)
+```bash
+# Clone the repository
+git clone --filter=blob:none --branch canary --single-branch https://github.com/kurosakishigure/katharsis.git
 
-Run the unit tests to ensure that everything in the project is functioning correctly:
+# Install the project
+cd katharsis && cargo build --release
 
-```bash
-cargo test
+# Move the binary to the appropriate directory
+mv target/release/katharsis /usr/local/bin
 ```

docs/USE.md

@@ -1,90 +1,8 @@
 # Use the Katharsis
 
-## Prerequisites
-
-### Linux and macOS
-
-If you're using **Cargo**, please run:
-
-```bash
-cargo install katharsis
-# or
-cargo binstall katharsis
-```
-
-> [!NOTE]
-> Use the following command to install the `canary` version:
-> 
-> ```bash
-> cargo install katharsis@1.0.0-canary.21
-> # or
-> cargo binstall katharsis@1.0.0-canary.21
-> ```
-
-> - You might also need to add the environment variable `export PATH=$HOME/.cargo/bin:$PATH` to your `.zshrc` or `.bashrc` file.
-> - If you choose to use `cargo binstall katharsis`, you might need to run `brew install cargo-binstall` first.
-
-For **Arch Linux**, [katharsis](https://aur.archlinux.org/packages/katharsis) is available as a package in the AUR.
-
-You can install it using an AUR helper (e.g. paru):
-
-```bash
-paru -S katharsis
-```
-
-If you're using a **Debian-based system**, you can directly install the `.deb` file from the download directory using `apt`:
-
-```bash
-sudo apt install katharsis.deb
-```
-
-> - Download the appropriate binary from the [Releases](https://github.com/kurosakishigure/katharsis/releases/latest) page.
-> - You can find the platform comparison table in the [Platform Support](https://doc.rust-lang.org/rustc/platform-support.html) section.
-
-Otherwise, you'll need to follow the **step-by-step** instructions below to install Katharsis.
-
-Run the following command to extract the downloaded file:
-
-```bash
-tar -xzf ~/your/download/path/katharsis.tar.gz
-```
-
-Next, execute the following command in your home directory to create the necessary folders:
-
-```bash
-mkdir -p Formulae/bin
-```
-
-Move the downloaded binary to `~/Formulae/bin`:
-
-```bash
-mv ~/your/extract/path/katharsis ~/Formulae/bin/katharsis
-```
-
-Modify your `.zshrc` or `.bashrc` file by adding the following configuration:
-
-```bash
-# Formulae
-export PATH=$HOME/Formulae/bin:$PATH
-```
-
-> Typing `katharsis` might be cumbersome, so you can use a shorter alias like `rss` in your `.zshrc` or `.bashrc` file instead:
->
-> ```bash
-> alias rss=katharsis
-> ```
-
-Run the following command to apply the changes:
-
-```bash
-source .zshrc
-# or
-source .bashrc
-```
-
 ## Example
 
-> You can refer to our [Examples](../examples).
+> You can refer to our [examples](../examples).
 
 Run the following command to generate a `katharsis.config.toml` file in the current directory:
 
@@ -98,8 +16,6 @@ Run the following command to create a default `rss.xml`:
 katharsis
 ```
 
-For a detailed explanation of the fields in the `katharsis.config.toml` file, refer to the Overview section below.
-
 ## Command Overview
 
 | Command | Description                                                        |