Skip to content

Latest commit

 

History

History
22 lines (17 loc) · 1.24 KB

README.md

File metadata and controls

22 lines (17 loc) · 1.24 KB

OpenUsage documentation

What the app does and how it behaves. These pages describe behaviour, not visuals, and change together with the behaviour they describe. If the app and a page here disagree, that is a bug.

The app

  • Dashboard: cards, accounts, metrics, right-click menus, reordering, keyboard shortcuts
  • Accounts: adding, renaming, and removing accounts; how sign-in works
  • Menu bar: starring metrics into the menu bar
  • Settings: every option and what it changes
  • Command line: the openusage command, its JSON output, and installing it
  • Refreshing: when data updates and what happens when a fetch fails
  • Providers: how each provider signs in and what it shows
  • Updates: automatic updates, manual checks, and the beta channel
  • Privacy: what stays on your Mac and what the anonymous telemetry sends

For developers

  • Architecture: the composition root, the stores, the account runtime, the AppKit bridge
  • Adding a provider: the sign-in and usage contract, and the register, test, document steps
  • Debugging: running a local build and reading its logs