Improve documentation clarity, fix typos, and align project descriptions

[johnbrandborg]

Summary

• README rewritten — shorter, scannable, leads with a full CRUD lifecycle example and a quickstart section instead of a wall-of-text sales pitch
• Descriptions aligned — PyPI (pyproject.toml), README, docs landing page, and GitHub About now all use the same core message: "A lightweight Python client for REST APIs — create, read, update, and delete with zero boilerplate"
• Changelog updated — added missing entries for releases 1.4.1, 1.4.2, and 1.5.0
• Docs landing page restructured — leads with a quickstart, keeps the value proposition concise, moves detailed comparisons to the user guide
• Examples expanded — added JSONPlaceholder, GitHub API, Open-Meteo weather, and OAuth2 examples alongside the existing Databricks one
• Typos and grammar fixed across docs:
  • type(date) → type(data) in README hero example
  • API's → APIs in PyPI description
  • it's most basic from → its most basic form
  • pressuming → presuming
  • Orgination → Organization
  • highlight recommended → highly recommended
  • written URLLib3 → written with URLLib3

Test plan

• Verify README renders correctly on GitHub
• Verify PyPI description after next release
• Build docs locally (make -C docs html) and check index, user guide, examples, and changelog pages render correctly
• Confirm GitHub About sidebar shows the updated description

Made with Cursor

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud