Skip to content

Revise README for clarity, making it a bit more user friendly and quick to navigate - #129

Open
Ariandr wants to merge 3 commits into
NotProtonNot:mainfrom
Ariandr:patch-1
Open

Ariandr wants to merge 3 commits into
NotProtonNot:mainfrom
Ariandr:patch-1

Conversation

@Ariandr

@Ariandr Ariandr commented Oct 11, 2026

Copy link
Copy Markdown

Hi, thank you for the project, it's amazing!

Wanted to make a small contribution and propose README changes to make it well structured and easier to extend if needed.

I updated descriptions and added sections for compatibility, installation, configuration, limitations, development, contributing, and acknowledgments, following standard Github README structure.

Feel free to edit it however you like 🙂

Updated descriptions and added sections for compatibility, installation, configuration, limitations, development, contributing, and acknowledgments.
Added installation instructions for Homebrew and GitHub Releases.
@Ariandr Ariandr changed the title Revise README for clarity, making it a bit more user friendly and clear Revise README for clarity, making it a bit more user friendly and quick to navigate Oct 11, 2026
Condensed the contents section into a single line for better readability and saving vertical space.
@NotProtonNot

Copy link
Copy Markdown
Owner

Finally have had some time to look over this. I'm going to make some changes that match the idea of your PR, but not the actual language itself. The README has changed quite a bit since this was submitted (which is entirely my fault).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants