From 9475f2630c8159f19392b557c8020286f5019e95 Mon Sep 17 00:00:00 2001 From: Amolith Date: Wed, 10 Jun 2026 23:18:51 -0600 Subject: [PATCH] Make readme normal --- README.md | 51 +++++++++------------------------------------------ 1 file changed, 9 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index bdaeaf4a7ab7803848f55162182dc0b03a4152a5..7173bcb57c3aca03c09ca785414e10374e7db94d 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,18 @@ # Pebblexus -Pebblexus is a Pebble watchapp for checking Plexus quota status from -your wrist. +Pebble watchapp for checking Plexus quota statuses from your wrist. -Pebblexus groups quota meters from Plexus' management quota endpoint by -provider/checker ID. Up/down move between groups, select refreshes the -current list, and the footer shows the current page count. The -phone-side PebbleKit JS stores the user's Plexus base URL and admin key; -the key is never sent to the watch. +- Up/down navigates between groups +- Select refreshes the watch's data -## Requirements +I intend to add (all optional/configurable) periodic polling, warnings when +quotas approach limits, and maybe insert timeline pins for quota resets. Not +sure I'll add anything else? -- `mise` -- A Plexus instance reachable from the phone -- A Plexus admin key for that instance - -The development environment is described in `mise.toml`. It installs the -`pebble` CLI through mise's `pipx:pebble-tool` backend, pins the Python -runtime used by that tool, and adds the Pebble SDK toolchain to `PATH`. - -## Build +## Build/install for development ```sh mise run build -``` - -`mise run check` runs the same build without requiring an emulator. - -## Test on Emery - -```sh -mise run install -mise run screenshot -``` - -Interact with the app from the CLI: - -```sh -mise run emu:up # previous group -mise run emu:select # refresh quotas -mise run emu:down # next group -mise run emu:back # long-press back -``` - -Optional app-icon generation uses the local Pebble skill helper and the -Pebble tool Python environment, which includes Pillow via mise: - -```sh -mise run icons +# pebble login if you haven't already +pebble install --cloudpebble ```