docrev 0.6.3 → 0.6.5

package/README.md

@@ -1,118 +1,177 @@
 # docrev
 
 [![npm](https://img.shields.io/npm/v/docrev)](https://www.npmjs.com/package/docrev)
-[![Node.js](https://img.shields.io/node/v/docrev)](https://nodejs.org/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-CLI tool for academic paper workflows with Word ↔ Markdown round-trips. Handle reviewer feedback, manage comments, validate DOIs, and build to PDF/DOCX/LaTeX.
+**Write papers in plain text. Generate Word when needed.**
+
+## Why
+
+Word documents corrupt. Versions multiply. Track changes become unreadable. Equations break. Figures embed at wrong resolutions.
+
+docrev solves this: write in Markdown, generate Word/PDF for collaborators. They use Word normally. You get version control, clean diffs, and automated formatting.
+
+```
+Markdown files  -->  docrev  -->  Word/PDF
+      ^                              |
+      |                              v
+      +---- docrev <---- reviewer feedback
+```
 
 ## Install
 
 ```bash
 npm install -g docrev
+brew install pandoc
 ```
 
-**Prerequisites:** [Pandoc](https://pandoc.org/installing.html) and optionally [pandoc-crossref](https://github.com/lierdakil/pandoc-crossref)
+## Start a Project
 
+From scratch:
 ```bash
-# macOS
-brew install pandoc pandoc-crossref
+rev new my-paper
+cd my-paper
+```
 
-# Verify
-rev --version
-rev install
+From existing Word document:
+```bash
+rev import manuscript.docx
 ```
 
-## Quick Start
+Project structure:
+```
+my-paper/
+├── introduction.md
+├── methods.md
+├── results.md
+├── discussion.md
+├── references.bib
+└── rev.yaml
+```
 
-```bash
-# Create new project
-rev new my-paper
+## Markdown Basics
 
-# Or import from Word
-rev import manuscript.docx
+```markdown
+# Heading
+
+Paragraph text. **Bold** and *italic*.
 
-# Edit sections: introduction.md, methods.md, results.md, discussion.md
+- Bullet point
+- Another point
 
-# Build outputs
-rev build pdf
-rev build docx
-rev build --dual    # Clean + comments DOCX with threaded comments
+1. Numbered item
+2. Second item
 ```
 
-## Reviewer Workflow
+### Citations
 
-```bash
-# Import reviewed Word doc to section files
-rev sections reviewed.docx
+references.bib:
+```bibtex
+@article{Smith2020,
+  author = {Smith, Jane},
+  title = {Paper Title},
+  journal = {Nature},
+  year = {2020}
+}
+```
 
-# Review track changes interactively
-rev review methods.md
+In text:
+```markdown
+Previous studies [@Smith2020] demonstrated this.
+```
 
-# See and reply to comments
-rev comments methods.md
-rev reply methods.md -n 1 -m "Added clarification"
+Output: "Previous studies (Smith 2020) demonstrated this."
 
-# Rebuild
-rev build docx --dual
+### Equations
+
+Inline: `$E = mc^2$`
+
+Display:
+```markdown
+$$
+\hat{p} = \frac{\sum_d w_d p_d}{\sum_d w_d}
+$$
 ```
 
-## Key Features
+### Figures
 
-- **Build system** - Sections → paper.md → PDF, DOCX, LaTeX
-- **Word import** - Extracts text, comments, equations (OMML → LaTeX), and images
-- **Interactive review** - Accept/reject track changes with TUI
-- **Comment threading** - Guy→Gilles reply pairs become threaded Word comments
-- **Cross-references** - `@fig:label` → "Figure 1" (auto-converted from Word)
-- **DOI validation** - Check and lookup DOIs via Crossref/DataCite
-- **Journal validation** - Check against 21 journal requirement profiles
+```markdown
+![Study site locations](figures/map.png){#fig:map}
 
-## Commands
+Results shown in @fig:map indicate regional variation.
+```
 
-| Command | Description |
-|---------|-------------|
-| `rev build [pdf\|docx\|tex]` | Build outputs from sections |
-| `rev build --dual` | Clean + comments DOCX |
-| `rev import <docx>` | Bootstrap project from Word |
-| `rev sections <docx>` | Import to existing section files |
-| `rev review <file>` | Interactive accept/reject TUI |
-| `rev comments <file>` | List comments with context |
-| `rev reply <file> -n N -m "text"` | Reply to comment |
-| `rev doi check [file.bib]` | Validate DOIs |
-| `rev doi lookup [file.bib]` | Find missing DOIs |
-| `rev validate -j <journal>` | Check journal requirements |
+Output: "Results shown in Figure 1 indicate regional variation."
 
-See [docs/commands.md](docs/commands.md) for full command reference.
+Figure numbers update automatically when reordered.
 
-## Annotation Syntax (CriticMarkup)
+## Build
 
-```markdown
-{++inserted text++}      # Insertions
-{--deleted text--}       # Deletions
-{~~old~>new~~}           # Substitutions
-{>>Author: comment<<}    # Comments
+```bash
+rev build docx          # Word document
+rev build pdf           # PDF
+rev build --dual        # Clean + comments versions
+rev watch docx          # Auto-rebuild on save
 ```
 
-## Project Structure
+## Handle Reviewer Feedback
 
+Import reviewed document:
+```bash
+rev sections reviewed.docx
 ```
-my-paper/
-├── rev.yaml           # Config (title, authors, build settings)
-├── introduction.md    # Section files
-├── methods.md
-├── results.md
-├── discussion.md
-├── references.bib     # Bibliography
-├── figures/           # Images
-└── paper.docx         # Generated output
+
+View comments:
+```bash
+rev comments methods.md
 ```
 
-## Documentation
+Reply to comment:
+```bash
+rev config user "Your Name"
+rev reply methods.md -n 1 -m "Clarified sampling methodology"
+```
 
-- [Commands Reference](docs/commands.md) - All commands with examples
-- [Configuration](docs/configuration.md) - rev.yaml options
-- [Workflow Guide](docs/workflow.md) - Step-by-step reviewer workflow
-- [API Reference](docs/api.md) - Library usage
+Rebuild with threaded comments:
+```bash
+rev build --dual
+```
+
+Output:
+- `paper.docx` (clean)
+- `paper_comments.docx` (with comment threads)
+
+## Commands
+
+| Task | Command |
+|------|---------|
+| New project | `rev new my-paper` |
+| Import Word | `rev import manuscript.docx` |
+| Build Word | `rev build docx` |
+| Build PDF | `rev build pdf` |
+| Import feedback | `rev sections reviewed.docx` |
+| View comments | `rev comments methods.md` |
+| Reply to comment | `rev reply methods.md -n 1 -m "text"` |
+| Word count | `rev word-count` |
+| Validate DOIs | `rev doi check` |
+| Pre-submit check | `rev check` |
+
+Full reference: [docs/commands.md](docs/commands.md)
+
+## Requirements
+
+- Node.js 18+
+- Pandoc
+
+```bash
+# macOS
+brew install pandoc
+
+# Windows
+winget install JohnMacFarlane.Pandoc
+
+# Linux
+sudo apt install pandoc
+```
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docrev",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Academic paper revision workflow: Word ↔ Markdown round-trips, DOI validation, reviewer comments",
   "type": "module",
   "types": "types/index.d.ts",