@okhay-p/mivra 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Oakkar Phyo
+
+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.

package/README.md

@@ -1,3 +1,37 @@
-# Temporary Holding Version
+# Mivra
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A local-first AI tutor that teaches with interactive visualizations, checks and courses. Everything runs on your computer: no account, and your data stays in `~/.mivra`.
+
+## Start
+
+Needs [Node.js](https://nodejs.org) 22.14 or newer.
+
+```sh
+npx @okhay-p/mivra
+```
+
+Or install it once with `npm install -g @okhay-p/mivra`, then run `mivra`.
+
+This starts Mivra and opens it in your browser. The first time, it asks for an API key from [OpenRouter](https://openrouter.ai/keys) (one key reaches every model), Anthropic or OpenAI.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `mivra` | Start Mivra and open it; Ctrl+C stops it. Uses port 4096, or the next free one |
+| `mivra --detach` | Run it in the background |
+| `mivra stop` / `mivra status` | Stop the background Mivra, or say where it runs |
+| `mivra auth set openrouter` | Save an API key (also `anthropic`, `openai`); it asks for the key without showing it |
+| `mivra auth status` / `mivra auth remove <provider>` | See or remove saved keys |
+
+Options: `--port <n>` to use one port only, `--no-open` to skip the browser. `MIVRA_DATA_DIR` moves the data folder. Keys in `OPENROUTER_API_KEY`, `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` take precedence over saved ones.
+
+Only a browser on the same computer can change API keys. Mivra listens on `127.0.0.1` only.
+
+Or run it with Docker, keeping data in a volume:
+
+```sh
+docker run -d -p 127.0.0.1:4096:4096 -v mivra-data:/data -e OPENROUTER_API_KEY=sk-or-... ghcr.io/okhay-p/mivra
+```
+
+Source, issues and design decisions: <https://github.com/okhay-p/mivra>