[roncodes]

Summary

The old README was an install command, the lint/test scripts, and two unrelated deep dives (resource transformers and realtime channel auth). It never said what core-api is, what it provides, or how extensions build on it. It also listed PHP 8.0+, but the package requires ^8.1.

This PR rewrites it from scratch as a README for the package itself.

• What core-api is and where it fits in a Fleetbase install. A Mermaid diagram shows the console, SDKs and OAuth apps → API (extensions on top of core) → MySQL, Redis, SocketCluster and webhooks, alongside the three route groups (int/v1, v1, oauth).
• What's included: a capability table covering organizations and identity, access control, the API platform, Sign in with Fleetbase, webhooks, realtime, notifications, SMS and the SMS guard, files, collaboration, reports and templates, scheduling, and operations.
• Requirements and installation, including the setup command sequence from the API's deploy.sh.
• Building on core-api: a minimal extension (service provider, model, controller, routes, filter), the routes fleetbaseRoutes() generates, and the Resource/Filter/Request naming conventions the controller resolves.
• Querying the REST API: limit, page, sort, query, column and range filters, with/expand, with_count, without.
• Extension points: transformers, socket channels, notifications, report schemas, OAuth scopes, App Review, expansions, webhook events, middleware groups and scheduled tasks.
• Configuration: the commonly used environment variables. Artisan commands, grouped. Development: composer scripts and CI.
• Contributing, security, community and dual-license sections that match fleetbase/fleetbase.

Badges: added CI, Packagist version, PHP version, downloads, license and Discord next to the existing Codecov badge.

Moved, unchanged: the resource transformer and realtime channel authentication sections now live in docs/resource-transformers.md and docs/realtime-channel-authentication.md. The README links to them from the extension points and configuration tables.

Review notes

• I checked every claim against main (routes, HasApiModelBehavior, Filter, Find, config defaults, command signatures). Search (query) and range filters depend on the resource's filter class, and the README says so.
• I checked every link and badge: all return 200 except the example curl URL, which needs an API key. The Mermaid block was parsed and rendered with Mermaid 10.9.1.
• The example extension (Parcels) is illustrative and not a real package.
• Documentation only. No code changes.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ac97b56) to head (bb650b8).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##                main      #328   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity      9600      9600           
===========================================
  Files            519       519           
  Lines          29841     29841           
===========================================
  Hits           29841     29841           

Flag	Coverage Δ
backend	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.