docs: improve README documentation

[Munnin-aen-Huggin]

Improved Documentation

Hey! I noticed this repo could use better documentation, so I generated an improved README using Codec8 — an AI documentation generator.

What changed:

• Added clear installation instructions
• Added usage examples
• Improved project description and features
• Added standard README structure

Feel free to modify anything that's not accurate. This is just a starting point!

---

Generated by Codec8 — AI-powered docs for GitHub repos. Free to try on your own repos.

Note

Expand README with project overview, quick start, and contributing guidelines

Replaces the minimal README.md with a full project README. Adds technology/GitHub badges, a Features section, Quick Start instructions (via npx and desktop app), links to .docs documentation files, project status, contributing guidelines, and Discord/support links.

^{Macroscope summarized da3ca41.}

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 25d6ce71-37ea-450a-b9a0-83d940298e39

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can enforce grammar and style rules using `languagetool`.

Configure the reviews.tools.languagetool setting to enable/disable rules and categories. Refer to the LanguageTool Community to learn more.

[binbandit]

Hey!

Thanks for the interest in contributing.

When it comes to our docs in general we try and avoid the use of ai. It feels like it cheapens the project.

I personally also believe the current readme is pretty ok. Explains the project well whilst we are still getting to our feet.