Skip to content

docs: update README with companion app setup, WebSocket, and new env vars #3

@thenotespublisher

Description

@thenotespublisher

README is outdated after today's commits (companion app, DB, WebSocket).

Changes:

  • Added section: "Android Companion App" with build instructions (Kotlin, minSdk 26)
  • Documented new .env vars: DATABASE_URL (optional SQLite), WS_PORT
  • Explained dashboard connection flow (phone → ws://IP:port)
  • Added troubleshooting: "Accessibility permission denied" → grant steps
  • Fixed broken links, refreshed feature list (now 22→ actions unchanged, but + Android service)

Before/after screenshots attached if you want (optional but helps).

Tested: instructions work on fresh clone + Railway deploy

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