Skip to content

docs: Update README with new features and stats #80

Description

@melvincarvalho

Summary

The README needs updating to reflect recent additions and current project stats.

New Features to Add

v0.0.76+

Stats to Update

Current codebase:

  • Source code: ~13,000 lines (was likely less before)
  • Test code: ~4,700 lines
  • Total: ~17,700 lines
  • Test count: 223+ tests
  • Dependencies: 18 direct dependencies

Breakdown by module:

Module Lines
handlers/resource.js 962
idp/views.js 641
idp/interactions.js 531
patch/n3-patch.js 522
server.js 466
idp/provider.js 455
idp/accounts.js 449
rdf/turtle.js 442

Version Update

Change "Implemented (v0.0.75)" to current version.

Feature List Updates

Add to features list:

- **HTTP Range Requests** - Video/audio seeking, partial content delivery (206)
- **Passkey Authentication** - WebAuthn/FIDO2 passwordless login with Touch ID/Face ID
- **SolidOS UI** - Modern file manager interface (`--solidos-ui`)
- **Single-User Mode** - Simplified setup for personal pods (`--single-user`)

CLI Options to Document

New flags that may be missing:

  • --solidos-ui - Enable SolidOS modern UI
  • --single-user <webid> - Single-user mode for personal servers
  • --range-requests (if configurable, or just note it's always on)

Optional: Add Stats Section

Consider adding a "Project Stats" section:

## Project Stats

- ~13,000 lines of source code
- ~4,700 lines of tests (223+ tests)
- 18 direct dependencies
- Zero native dependencies (pure JavaScript, runs on Termux/Android)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions