@moreai/code 0.1.0-beta.2 → 0.1.0-beta.3

package/README.md

@@ -13,26 +13,85 @@
 </p>
 
 <p align="center">
-  <img alt="More AI Code exploring a repository, editing a file, writing a test, running it and summarising the change" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.2/media/session.webp" width="860">
+  <img alt="More AI Code exploring a repository, editing a file, writing a test, running it and summarising the change" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.3/media/session.webp" width="860">
 </p>
 
+More AI Code is an assistant that works in your project from the terminal.
+Describe a task in plain words — "fix the failing test", "add validation to
+the signup form", "explain how billing works" — and it reads the code, edits
+the files, runs the commands and tests, and tells you what it changed. You stay
+in control: anything risky waits for your yes.
+
+It works with the AI you already have: an API key from more than 30 providers, a
+ChatGPT, GitHub Copilot or Claude subscription, or a model running on your own
+computer. No account and no desktop app are needed.
+
 ## Install
 
 ```sh
 npm install -g @moreai/code
+```
+
+> **Keep the `-g`.** The install box in npm's sidebar shows
+> `npm i @moreai/code`, which only adds the package to the current folder — the
+> `moreai` command appears only after a global install.
+
+Requires **Node.js 22 or newer** (`node --version`) on macOS, Linux or Windows.
+Check the install with `moreai --version`. On Linux, if npm answers `EACCES`,
+install Node with a version manager such as [nvm](https://github.com/nvm-sh/nvm)
+or [fnm](https://github.com/Schniz/fnm) instead of using `sudo`.
+
+## Get started in three steps
+
+### 1. Open your project and connect a model
+
+```sh
 cd your-project
 moreai
 ```
 
-Requires **Node.js 22 or newer** on macOS, Linux or Windows. The first launch
-helps you connect a model; nothing else is required — no account, no desktop app.
+The first launch asks how to reach a model. Pick a provider from the list (type
+to search), then paste an API key, sign in with your subscription, or choose a
+local model from Ollama or LM Studio. Keys stay on your machine.
+
+<p align="center">
+  <img alt="The first launch: a searchable list of AI providers — Anthropic, OpenAI, ChatGPT, Google Gemini, GitHub Copilot, OpenRouter and more" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.3/media/connect.webp" width="760">
+</p>
+
+Already have `ANTHROPIC_API_KEY`, `OPENAI_API_KEY` or another provider key in
+your environment? It is offered at the top of the list.
+
+### 2. Say what you want done
+
+Type the task as you would tell a colleague and press **Enter**. The line under
+the prompt shows the access mode, the model and your branch.
+
+<p align="center">
+  <img alt="A session in a project folder, with the task typed into the prompt" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.3/media/start.webp" width="760">
+</p>
+
+### 3. Follow along and approve what matters
+
+The agent shows every step: files it reads, each edit as a diff, commands and
+their output. You choose how much it may do on its own. In `accept-edits`,
+shown here, it edits files freely and stops before every command — allow it
+once, for the session, always, or deny it. In `auto`, the default, it runs
+what it can show is safe and declines the rest.
+
+<p align="center">
+  <img alt="A permission card asking to run npm test, with the choices Allow once, Allow for this session, Always allow and Deny" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.3/media/approve.webp" width="760">
+</p>
+
+While it works you can keep typing to steer it, **Esc** interrupts, and
+**Shift+Tab** switches the access mode (see *Access modes* below). `/help`
+lists every command.
 
 ## What it does
 
 - **Works in your repository.** Reads and searches the code, edits files and
   shows each change as a diff, runs commands and tests, keeps a checklist of
   its own plan, and answers in plain language.
-- **Runs on your models.** About 40 providers: Anthropic, OpenAI, Google
+- **Runs on your models.** More than 30 providers: Anthropic, OpenAI, Google
   Gemini, OpenRouter, DeepSeek, Groq, local models through Ollama or LM Studio,
   any OpenAI-compatible endpoint, and ChatGPT or GitHub Copilot subscriptions.
   Keys stay on your machine.
@@ -47,23 +106,16 @@ helps you connect a model; nothing else is required — no account, no desktop a
 - **Listens.** `Ctrl+T` dictates into the prompt.
 - **Speaks your language.** The interface is translated into 35 languages.
 
-## Getting started
+## Everyday commands
 
 ```sh
 moreai            # interactive session in this folder
 moreai setup      # guided setup: model, optional account and services
 moreai auth       # connect or change an AI provider
+moreai auth env   # connect every provider key found in your environment
 moreai doctor     # check that everything is ready
 ```
 
-If a provider key is already in your environment (`ANTHROPIC_API_KEY`,
-`OPENAI_API_KEY`, …), the first launch offers it at the top of the list, and
-`moreai auth env` connects every one it finds.
-
-In a session, type a task and press **Enter**. While the agent works you can
-keep typing to steer it, **Esc** interrupts, and **Shift+Tab** changes the
-access mode. `/help` lists every command.
-
 ## Access modes
 
 | Mode | What the agent may do |
@@ -79,7 +131,7 @@ Pick one with **Shift+Tab** in a session or `--mode <mode>` on the command line.
 ## Helper agents
 
 <p align="center">
-  <img alt="Three parallel helper agents researching webhooks, each with its result, then the combined answer" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.2/media/helpers.webp" width="860">
+  <img alt="Three parallel helper agents researching webhooks, each with its result, then the combined answer" src="https://cdn.jsdelivr.net/npm/@moreai/code@0.1.0-beta.3/media/helpers.webp" width="860">
 </p>
 
 For broad questions the agent can start several **helper agents** in