Skip to content

Refactor README for better readability - #263

Open
Ved2009 wants to merge 1 commit into
andrewyng:mainfrom
Ved2009:patch-1
Open

Refactor README for better readability#263
Ved2009 wants to merge 1 commit into
andrewyng:mainfrom
Ved2009:patch-1

Conversation

@Ved2009

@Ved2009 Ved2009 commented Jul 27, 2026

Copy link
Copy Markdown

Updated README to improve clarity and formatting.

Updated README to improve clarity and formatting.
@Ved2009

Ved2009 commented Jul 27, 2026

Copy link
Copy Markdown
Author

This PR cleans up the README for readability without changing any content or voice:

  • Completed the "Contributing" section, which was cut off in the original (bug/issue reporting, PR guidance, connector pattern pointer)
  • Added a table of contents for easier navigation given the doc's length
  • Minor consistency fixes ("the App" → "the app", "API-keys" → "API keys" to match style used elsewhere)
  • Reformatted the Tests/Desktop bundles section into a bullet list instead of one dense sentence

Happy to adjust scope or split into smaller PRs if preferred — let me know.

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.

1 participant