docs: Initial specification + install guide

[greynewell]

Summary by CodeRabbit

• Documentation

  • Expanded README with installation instructions, API endpoints overview, and authentication details.

• Chores

  • Added automated OpenAPI specification validation.
  • Updated package metadata with project information.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This PR sets up project infrastructure and documentation. It adds a GitHub Actions workflow to automatically validate OpenAPI specifications on code changes, expands the README with installation instructions and endpoint documentation, and adds metadata fields to package.json for better project discoverability.

Changes

Cohort / File(s)	Summary
CI/CD Validation Setup .github/workflows/validate.yml	New GitHub Actions workflow triggered on pushes and PRs to main branch. Runs OpenAPI linting via Redocly on openapi.yaml to catch spec issues early.
Project Metadata package.json	Added three new fields: homepage (URL), bugs (object with URL), and keywords (array). Helps with package discoverability and issue tracking.
Documentation Expansion README.md	Replaced minimal "Read more" with comprehensive guide including npm/OpenAPI badges, installation instructions, endpoints table, authentication notes, and links section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🔍 A workflow watches over specs so fine,
📖 Docs expand, their glory now to shine,
📦 Metadata blooms for all to find,
The API's foundation, thoughtfully designed ✨

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 037584a and 729199a.

📒 Files selected for processing (3)

• .github/workflows/validate.yml
• README.md
• package.json

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}