Fix README typos and update README.md references

[bell-kevin]

Motivation

• Clean up minor spelling, grammar, and capitalization issues in the project root README.md for clarity and consistency.
• Standardize terminology around technologies (e.g., Python (Flask), Electron-based, JavaScript) to match common usage.
• Ensure cross-references point to the actual packaging docs (pkg/mac/README.md, pkg/win32/README.md) that exist in the repository.

Description

• Replace Python(Flask) with Python (Flask) and Electron based with Electron-based in README.md.
• Normalize wording to third-party JavaScript and change it's own to its own and asset as it's needed to asset as it is needed.
• Update phrasing for the Python environment to Python virtual environment is set up and adjust comment headers such as # Change pgAdmin server and port and # Change pgAdmin config DB path... for spacing and clarity.
• Update documentation links to point to *pkg/mac/README.md* and *pkg/win32/README.md* instead of the older referenced filenames.

Summary by CodeRabbit

Release Notes

• Documentation
  • Updated README with expanded architecture section and clarified system component descriptions
  • Added configuration examples for server and desktop mode settings
  • Improved documentation cross-references for macOS and Windows setup guides
  • Corrected terminology and phrasing throughout

[coderabbitai]

📝 Walkthrough

Walkthrough

The README.md was updated with grammar corrections, architectural clarifications, enhanced configuration examples, and cross-links to platform-specific build documentation. Changes include corrected capitalization, improved phrasing, expanded configuration examples, and updated file references.

Changes

Documentation Refinements

Layer / File(s)	Summary
Architecture Clarification README.md (lines 12–18)	pgAdmin 4 description updated to clarify it is a web application with Python/Flask backend, ReactJS/HTML5/CSS frontend, and an Electron-based runtime in the runtime subdirectory.
Language & Phrasing README.md (lines 34–38, 63–64)	Grammar and capitalization corrections: "third party Javascript" → "third-party JavaScript," "it's" → "its," "Python Virtual Environment is setup" → "Python virtual environment is set up."
Configuration Examples README.md (lines 115–125)	Configuration section expanded with concrete examples for DEFAULT_SERVER, DEFAULT_SERVER_PORT, SERVER_MODE, and CONFIG_DATABASE_URI, plus SMTP settings guidance.
Documentation Cross-Links README.md (lines 229–231)	Added cross-links to platform-specific build documentation (pkg/mac/README.md, pkg/win32/README.md) and updated macOS/Windows readme references to .md format.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~10 minutes

Poem

📚 The rabbit hops through words with care,
Fixing grammar here and there,
Architecture shines so bright,
Configuration examples right,
A tidy README, polished fair! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: fixing typos and updating README.md references, which are the primary objectives of the PR.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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.}

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

13-13: ⚡ Quick win

Hyphenate "client side" for consistency.

For consistency with the "Electron-based" fix on line 17, "client side" should be hyphenated when used as a compound adjective modifying "processing". As per static analysis, this should be "client-side processing".

📝 Suggested fix

-and ReactJS, HTML5 with CSS for the client side processing and UI.
+and ReactJS, HTML5 with CSS for the client-side processing and UI.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 13, Replace the unhyphenated phrase "client side
processing" with the compound adjective "client-side processing" in the README
(the same sentence that mentions Electron-based on the surrounding line), i.e.,
update the phrase "and ReactJS, HTML5 with CSS for the client side processing
and UI." to use "client-side processing" for consistency.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Line 13: Replace the unhyphenated phrase "client side processing" with the
compound adjective "client-side processing" in the README (the same sentence
that mentions Electron-based on the surrounding line), i.e., update the phrase
"and ReactJS, HTML5 with CSS for the client side processing and UI." to use
"client-side processing" for consistency.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7efbd8ed-d351-45be-9563-3c0c0003f586

📥 Commits

Reviewing files that changed from the base of the PR and between 86a8b16 and dc373bc.

📒 Files selected for processing (1)

• README.md