Improves the README documentation - #333
Merged
Merged
Conversation
Zavy86
marked this pull request as draft
August 19, 2026 13:34
…nstructions, and contribution guidelines.
…ve feature highlights.
…structions, and enhance overall readability.
…demo section, and update layout for clarity.
…ads" badge for accuracy.
…ve clarity throughout.
…ove clarity in setup and migration instructions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly improves the
README.mddocumentation for Wiki|Docs, making it more user-friendly and informative. The changes introduce a clearer project overview, highlight new features and architecture, provide updated setup instructions, add screenshots, and improve sections on migration, help, and contributing. Additionally, a project configuration file for JavaScript library mappings is added.Key documentation improvements:
README.mdto provide a clearer introduction, highlight privacy and portability, explain the new TypeScript-based architecture, and clarify the differences between desktop and self-hosted usage.