@sriinnu/runic 2.0.0 → 2.11.2

package/LICENSE

@@ -1,21 +1,373 @@
-MIT License
-
-Copyright (c) 2025-2026 Srinivas Pendela
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -2,92 +2,63 @@
 
 <div align="center">
 
-<img src="runic.png" alt="Runic — infinity symbol with usage bars" width="160" />
+<img src="runic.png" alt="Runic infinity symbol with usage bars" width="144" />
 
-**AI usage monitoring for your Mac menubar.**
-
-Track usage, costs, and quotas across 26 AI providers in real time.
+**Local-first AI usage visibility for macOS.**
 
 ![macOS 14+](https://img.shields.io/badge/macOS-14%2B-000?logo=apple)
 ![Swift 6.2](https://img.shields.io/badge/Swift-6.2-F05138?logo=swift&logoColor=white)
-![License MIT](https://img.shields.io/badge/license-MIT-blue)
+![License MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-blue)
 
 </div>
 
----
-
-## What it does
-
-Runic sits in your menubar and shows how much of your AI subscription you've used, what it's costing, and when your limits reset. One click gives you charts, breakdowns, and forecasts across all your providers.
-
-## Supported Providers
-
-| | | |
-|---|---|---|
-| Claude (1M ctx) | Codex (400K ctx) | Cursor (128K ctx) |
-| Gemini (1M ctx) | Copilot (128K ctx) | z.ai (205K ctx) |
-| OpenRouter | Groq (128K ctx) | DeepSeek (64K ctx) |
-| Fireworks (128K ctx) | Mistral (128K ctx) | Perplexity (128K ctx) |
-| Kimi (128K ctx) | Together (128K ctx) | Cohere (128K ctx) |
-| xAI (128K ctx) | Cerebras (128K ctx) | SambaNova (128K ctx) |
-| Azure OpenAI | Bedrock | Vertex AI |
-| Qwen (128K ctx) | MiniMax | Auggie |
-| Antigravity | Factory (Droid) | |
-
-Context windows are configurable via `Resources/provider-context-windows.json`.
-
-## Features
-
-**Overview dashboard**
-- All providers at a glance with brand icons and progress bars
-- Activity ring showing average usage across providers
-- Context window, reset countdown, and usage window per provider
-- Combined 7-day stacked bar chart
-
-**Per-provider view**
-- Hero stat with provider icon, today's token count and cost
-- Inline line chart with 1h / 6h / 1d / 7d / 30d range picker
-- Glassmorphism stat cards (Peak Hour, This Week) with sparklines
-- Usage progress bars with sheen animation and glow effects
-- Live "Updated Xs ago" timestamp
-
-**Charts** (submenus)
-- Usage timeline (area + line, Catmull-Rom interpolated)
-- Today by hour (24-bar chart with peak highlight)
-- Last 7 days (weekly bar chart)
-- Subscription utilization (Daily / Weekly / Monthly)
-- Usage window comparison (dual-line session vs weekly)
-- Model breakdown (donut chart)
-- Project breakdown (horizontal bar chart)
-
-**Analytics**
-- Token usage tracking (input, output, cache)
-- Cost estimation with per-model pricing
-- Spend forecasting with budget breach detection
-- Project and model attribution
-- Anomaly detection
-
-**Export & Notifications**
-- Export as CSV or JSON
-- Budget breach alerts via macOS notifications
-- macOS widgets (usage, history, compact, switcher)
-- CLI tool (`RunicCLI`)
-
-**Design**
-- Dark / Light / System theme
-- Liquid UI with glass materials and animated progress bars
-- Staggered entrance animations and glass shimmer effects
-- Custom font system — 7 bundled families (Fira Code, JetBrains Mono, IBM Plex Mono, Space Mono, Inconsolata, Caveat, SF Pro/Mono) with live switching
-- Drop-in font extensibility — add TTF/OTF to `Resources/Fonts`, rebuild, auto-discovered
-- Design tokens for typography, colors, spacing, corner radius, animation
-- VoiceOver accessible
-- Sparkle auto-updates
+Runic is a menubar app for seeing AI usage, quota signals, reset windows, cost estimates, context metadata, and local usage history across the providers you enable.
+
+Its job is not to make provider usage look cleaner than it is. Its job is to report what can be known, label what is inferred, and avoid pretending when a provider does not expose the data.
+
+## What We Stand For
+
+**Truth over polish.** Runic should never fake precision. If a number comes from a provider API, local log, browser session, pricing table, heuristic, or fallback, that provenance should be visible in the code and, where useful, in exports.
+
+**Local first.** Usage data belongs on the Mac by default. Runic has no product analytics, no telemetry, and no crash reporting. Network access is limited to the provider/status/update/webhook paths the app needs for enabled features.
+
+**No dark patterns.** Budget warnings, quota labels, exports, and cost estimates should help the user understand their usage, not scare them into a workflow or hide uncertainty.
+
+**Provider reality, not provider mythology.** Context windows are capability labels, not proof that every old token is semantically retained. Costs are best-effort unless provider-reported. Compaction tax is shown only when logs or telemetry explicitly identify compaction work.
+
+**Secrets stay out.** API keys and locally entered credentials belong in macOS Keychain or local provider sessions, not in git, screenshots, docs, diagnostics, or examples.
+
+## What It Does
+
+- Shows enabled provider usage from APIs, local CLIs, web sessions, local probes, and local telemetry where available.
+- Tracks token and cost history from Claude, Codex, and opencode logs through a compact, self-compacting Runic-owned relay: normal refresh reads today's live logs, history is backfilled automatically on first run, and an explicit rebuild repairs historical JSONL data on demand. Models routed through those tools (Qwen, GLM, Kimi, DeepSeek, …) are attributed to their own provider.
+- Tracks China and international platforms as separate accounts where a vendor runs both (Kimi, z.ai, MiniMax, Qwen, StepFun), so both subscriptions can be watched at once.
+- Hot-reloads `~/Library/Application Support/Runic/config.json` for endpoint overrides, extra log paths, and rolling-window quota gauges — edit the file, no restart.
+- Reads capability metadata from Kosha-discovery when present, then falls back to bundled context metadata.
+- Exports scoped usage data as CSV or JSON with provenance fields where known.
+- Provides a CLI for scripts and diagnostics.
+
+Provider behavior is uneven because provider surfaces are uneven. Claude and Codex expose richer local usage signals than most API-only providers. Some providers expose quota windows, some expose spend, some expose model inventory, and some expose almost nothing useful. Runic should make that unevenness visible instead of smoothing it away.
+
+## Privacy Boundary
+
+Runic keeps usage data on this Mac unless you export it, copy diagnostics, enable a configured webhook, or use a provider feature that requires a provider request.
+
+The local OpenTelemetry collector stores sanitized metric JSONL only: provider, model, timestamps, token counts, cache counts, IDs, explicit costs, SDK version, and explicit operation kind. Prompt and response content from upstream telemetry is not persisted.
+
+Local logs and CLI output can include account identity fields such as email addresses. Redact diagnostics before sharing them publicly.
 
 ## Install
 
-**Download** the latest release from [GitHub Releases](https://github.com/sriinnu/Runic/releases/latest), unzip, and drag `Runic.app` to Applications. Signed and notarized — no Gatekeeper warnings.
+Download the latest release from [GitHub Releases](https://github.com/sriinnu/Runic/releases/latest), unzip it, and move `Runic.app` to Applications.
+
+Homebrew:
+
+```bash
+brew install --cask sriinnu/tap/runic
+```
 
-**Or build from source:**
+Build from source:
 
 ```bash
 git clone https://github.com/sriinnu/Runic.git
@@ -95,30 +66,66 @@ cd Runic
 ./Scripts/compile_and_run.sh
 ```
 
-## Configure
+## CLI
 
-Open **Preferences** from the menubar. Each provider has its own settings:
+Runic bundles `RunicCLI`:
 
-- **API-based** (Groq, Mistral, z.ai, etc.): Paste your API key — provider auto-enables
-- **CLI-based** (Claude, Codex): Detected automatically from local CLI
-- **Cloud** (Bedrock, Vertex AI): Set environment variables
+```bash
+runic --provider all --format json --pretty
+runic cost --provider codex
+runic cost --provider codex --rebuild
+runic insights --provider all --view compaction --json --pretty
+runic otel-collect --port 4318
+```
 
-All tokens stored in macOS Keychain with no password prompts.
+Install it from Preferences -> Performance -> Refresh -> Install CLI.
 
-## Privacy
+`runic cost` refreshes today's live usage by default. `--rebuild` is the explicit historical repair path and may scan provider JSONL history.
 
-Zero telemetry. No analytics. No crash reporting. All data stays on your Mac.
+## MCP server and local tools
 
-## Roadmap
+Runic includes **one local MCP server** with two read-only tools: `runic_limits` (provider limits, resets, credits and balances where available) and `runic_health` (snapshot and refresh status). In the app, open **Settings → Sync → Integrations → Runic MCP**. The **Values available to MCP clients** section shows the actual provider readings from the local snapshot; **Check data** reloads that preview. Refresh usage in Runic to fetch new provider readings. **Copy client config** gives you the command for your AI client's MCP settings. The server starts on demand over stdio, so there is no port or always-running server to find.
 
-- Windows desktop app
-- Web app
+To see the same tool data locally, install the bundled CLI from **Settings → Performance → Refresh & Safety → Install CLI**, then run:
 
-## License
+```bash
+runic mcp list
+runic mcp call runic_health
+runic mcp call runic_limits
+runic mcp call runic_limits '{"provider":"codex"}'
+```
+
+Refresh usage in Runic first. A missing field means that provider has not supplied a verified value. To add tools, put a package folder containing `runic-mcp-plugin.json` and its executable in `~/Library/Application Support/Runic/mcpservers/`; Runic discovers it automatically and lists it in Settings. The built-in tools work even when that optional package list is empty. See the [MCP guide](docs/mcp.md) for a complete package example, client setup, and troubleshooting.
+
+## Docs
+
+- Provider behavior: [docs/providers.md](docs/providers.md)
+- CLI details: [docs/cli.md](docs/cli.md)
+- MCP server and tool packages: [docs/mcp.md](docs/mcp.md)
+- Architecture: [docs/architecture.md](docs/architecture.md)
+- Refresh loop: [docs/refresh-loop.md](docs/refresh-loop.md)
+- UI and widgets: [docs/ui.md](docs/ui.md), [docs/widgets.md](docs/widgets.md)
+- Packaging and releases: [docs/packaging.md](docs/packaging.md), [docs/releasing.md](docs/releasing.md)
 
-MIT. See [LICENSE](LICENSE).
+## Contributors And Agents
+
+Start with [SKILL.md](SKILL.md), [docs/architecture.md](docs/architecture.md), [docs/provider.md](docs/provider.md), and [docs/providers.md](docs/providers.md).
+
+Keep the root README as a statement of truth and project stance. Put detailed provider behavior, screenshots, local paths, feature matrices, research notes, and implementation reports in the right docs or ignored local notes.
+
+Do not commit keys, tokens, browser session dumps, local account screenshots, account emails, org IDs, unredacted diagnostics, or provider secrets.
+
+## Support
+
+Runic is open source. Sponsorship is optional and should fund maintenance, signing, CI, docs, and privacy-first usage features without changing the core promise: honest local usage visibility should stay open.
+
+## Acknowledgements
+
+Runic's menu layout and provider tab bar were inspired by [CodexBar](https://github.com/steipete/CodexBar), and its local cost accounting by the ccusage approach to reading coding-tool logs. The code here is Runic's own; ideas travel, and they should be credited.
+
+## License
 
----
+MPL-2.0. See [LICENSE](LICENSE). Bundled third-party software and fonts keep their own licenses, reproduced in [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md) and shipped inside the app bundle.
 
 <div align="center">