mdrules 0.2.0 → 0.2.3

package/README.md

@@ -24,8 +24,15 @@ Requires Node.js 20 or newer. From the root of any project (monorepos included):
 npx mdrules
 ```
 
-The first run asks a few questions (main doc, how to plan the work, the language you work in, rules)
-and opens the editor at `http://localhost:4319`. It only listens on `127.0.0.1`.
+The very first time, mdrules asks how you want your projects set up:
+
+- **With your answers** (default): answer once (main doc, how to plan the work, the language you
+  work in, rules…). They are saved in `~/.mdrules/defaults.json` and every new project is set up
+  with them, without questions. For a project that needs something else: `mdrules init --custom`.
+- **Ask in each project**: run `mdrules -D` the first time. Each project asks its own questions.
+
+Change your choice any time with `mdrules setup`. Then the editor opens at `http://localhost:4319`;
+it only listens on `127.0.0.1`.
 
 ## What it does
 
@@ -67,7 +74,9 @@ don't have to choose:
 
 - Run `mdrules translate` and pick a language to review the docs in: Spanish, French, Portuguese,
   German or Italian, or **type any other** (Japanese, Dutch…). mdrules then shows **every doc in that
-  language**, and the interface too for the built-in ones (menus stay in English for the others).
+  language**.
+- The menus are in English by default and don't depend on the docs' language: pick English, Spanish,
+  French, Portuguese, German or Italian in **Settings → General**.
   Read the architecture, tick tasks, write notes and fix a rule, all in your language.
 - The files in the repository **stay in one source language** (English by default), so the agent and
   the rest of the team keep reading one consistent version.
@@ -177,7 +186,8 @@ skill.
 
 - **Changes**: Git diff of your Markdown, grouped by folder and section.
 - **Rules**: reusable rule presets (e.g. "ask before committing") written into `CLAUDE.md` or `AGENTS.md`.
-- **Settings**: font, size, line spacing, margins, line width and wrapping; light and dark themes.
+- **Settings**, by section: General (interface language, theme), Editor (font, size, line spacing,
+  margins, line width, wrapping), Document languages and Proposals.
 
 ## Keyboard shortcuts
 
@@ -187,14 +197,19 @@ skill.
 | `Ctrl+Enter` | Tick or untick the task on the current line |
 | `Alt+H` | After pasting a table from a spreadsheet: toggle the header row |
 | `Ctrl+Z` / `Ctrl+Y` | Undo / redo |
-| `Ctrl+F` | Find and replace |
+| `Ctrl+F` / `Ctrl+H` | Find / find and replace (box at the top right) |
+| `Enter` / `Shift+Enter` | Next / previous match |
+| `Alt+C` / `Alt+W` / `Alt+R` | Match case / whole word / regular expression |
 | `Escape` | Close a menu or the selection toolbar |
 
 ## Commands
 
 ```bash
 mdrules                     # set up the project if needed, then open the editor
-mdrules init                # run the setup again
+mdrules init                # run the setup again (with your defaults, if you saved them)
+mdrules init --custom       # set up this project with its own answers
+mdrules setup               # change your defaults, or switch to asking in each project
+mdrules -D                  # first run: don't save defaults, ask in each project
 mdrules serve               # open the editor without the setup
 mdrules serve --port 5000 --no-open
 mdrules translate           # choose languages to review the docs in (also: mdrules --translate)