Improve README formatting and clarity#20
Merged
kWeglinski merged 1 commit intodevelopfrom Jul 14, 2025
Merged
Conversation
…er section headings, and additional information
kWeglinski
added a commit
that referenced
this pull request
Aug 2, 2025
* Fix url in footer (credits to credits where they belong to) * #15 - optional add to dict + ability to click highlight and minor ui improvements * ts fix * version bump * Improve README formatting and clarity with language annotations, better section headings, and additional information (#20) * Add unit tests for translate utils and API functions (#21) * fix tsc * v bump --------- Co-authored-by: Sebastian L. <sl@momou.ch> Co-authored-by: Krzysztof Węgliński <kweg@MacBook-Air-Krzysztof.local> Co-authored-by: Your Name <you@example.com>
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
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 improves the README file with several enhancements:
Changes Made:
yamllanguage annotations to code blocks for better clarityThese changes make the README more professional, easier to read, and more helpful for users who want to set up and use OmniPoly.
Key Improvements:
The changes are focused on improving documentation without modifying any functional code.