Skip to content

docs(readme): rewrite the README for v0.1.0 - #15

Merged
roncodes merged 1 commit into
release/v0.1.0from
docs/readme-l12
Nov 17, 2026
Merged

roncodes merged 1 commit into
release/v0.1.0from
docs/readme-l12

Conversation

@roncodes

Copy link
Copy Markdown
Member

The README was mostly a long essay on Solid's capabilities for logistics, plus a user needs assessment and a screenshot walkthrough. Its badges said PHP ^8.1, and the License section said MIT (the package is AGPL-3.0-or-later).

This rewrites it in the same layout as ledger's README:

  • what Solid is and what this extension does
  • features and architecture, including routes and Ember routes, taken from server/src and addon/
  • requirements: PHP ^8.2, core-api ^2.0, fleetops ^0.7.0, Node 22
  • the Solid-OIDC environment variables and defaults from server/config/solid.php
  • development steps and the existing Funding section

fleetbase/solid-api isn't on Packagist, so the README doesn't give a composer require line. It points to the console's Extensions section instead.

The README was mostly an essay on Solid for logistics, with PHP ^8.1,
Node and license details that no longer match. It now follows the other
extensions' README layout, with features, routes, configuration and
development steps taken from the code.
@codecov

codecov Bot commented Nov 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 26.49%. Comparing base (70560de) to head (f2bcf19).

Additional details and impacted files
@@                Coverage Diff                @@
##             release/v0.1.0      #15   +/-   ##
=================================================
  Coverage             26.49%   26.49%           
  Complexity              643      643           
=================================================
  Files                    19       19           
  Lines                  2265     2265           
=================================================
  Hits                    600      600           
  Misses                 1665     1665           
Flag Coverage Δ
backend 26.49% <ø> (ø)

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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@roncodes
roncodes merged commit 7acc661 into release/v0.1.0 Nov 17, 2026
7 checks passed
@roncodes
roncodes deleted the docs/readme-l12 branch November 17, 2026 06:48
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