Skip to content

Commit f993b39

Browse files
DeepanshKhuranaCopilot
andcommitted
feat: enhance README with spell check features and status bar details
Co-authored-by: Copilot <copilot@github.com>
1 parent bf0594d commit f993b39

1 file changed

Lines changed: 46 additions & 2 deletions

File tree

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![AI-DECLARATION: copilot](https://img.shields.io/badge/䷼%20AI--DECLARATION-copilot-fee2e2?labelColor=fee2e2)](https://ai-declaration.md)
44
[![Build](https://img.shields.io/github/actions/workflow/status/DeepanshKhurana/Prosaic/ci.yml?label=build)](https://github.com/DeepanshKhurana/Prosaic/actions/workflows/ci.yml)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
6+
[![Awesome CLI Apps](https://awesome.re/mentioned-badge.svg)](https://github.com/agarrharr/awesome-cli-apps#text-editors)
67

78
A writer-first terminal writing app built with Python and Textual, built with the assistance of LLM/Copilot tools.
89

@@ -58,6 +59,7 @@ prosaic [OPTIONS] [FILE]
5859
| `--dark` | Use dark theme |
5960
| `--profile <name>` | Use a specific profile |
6061
| `--profiles` | List all profiles |
62+
| `--languages` | List all supported spell check languages |
6163
| `--setup` | Run setup wizard again |
6264
| `--reference` | Show reference |
6365
| `--license` | Show MIT license |
@@ -73,12 +75,15 @@ prosaic --dark ~/writing/draft.md
7375
## Features
7476

7577
- **Markdown-first**: Live outline, word counting
78+
- **Spell check**: 80+ languages powered by hunspell (F7 to toggle)
79+
- **Autosave**: Files automatically save every 10 seconds
7680
- **Focus mode**: Hide everything except your writing
7781
- **Reader mode**: Distraction-free reading
7882
- **Start writing**: Quick writing session with all panes open
7983
- **Continue writing**: Resume your last edited document
8084
- **Daily metrics**: Track words and characters written each day
8185
- **Profiles**: Separate workspaces for different projects
86+
- **Status bar**: Real-time indicators for spell check, autosave, git status, and save state
8287
- **Git-ready**: Archive is Git-initialized for versioning
8388

8489
## Profiles
@@ -100,11 +105,30 @@ Each profile has its own:
100105
- Archive directory
101106
- Git remote (optional)
102107
- Theme preference
108+
- Spell check language (80+ languages supported)
103109

104110
Manage profiles from the dashboard menu (`m` key) or edit in `~/.config/prosaic/settings.json`.
105111

106112
**Upgrading from v1.1.1 or older?** Your existing setup is automatically preserved as the "default" profile. On first launch after upgrading, you'll be offered the option to set up additional profiles or rename your default.
107113

114+
## Spell Check
115+
116+
Prosaic supports 80+ languages powered by hunspell, including English, Spanish, French, German, Arabic, Hungarian, Polish, and many more.
117+
118+
```bash
119+
# List all supported languages
120+
prosaic --languages
121+
```
122+
123+
Spell check settings:
124+
- Language is set per profile during setup
125+
- Toggle on/off with `F7` in the editor
126+
- Change language anytime in manage profiles (`m` key on dashboard)
127+
- Status bar shows `spellcheck:on` or `spellcheck:off`
128+
- Existing users are prompted to set a language on first launch after upgrading
129+
130+
Common language codes: `en_US`, `en_GB`, `es_ES`, `fr_FR`, `de_DE`, `pt_BR`, `ar`, `hu_HU`, `pl_PL`, `ja`, `zh_CN`, `ru_RU`
131+
108132
## Books
109133

110134
Books are long-form writing projects stored as directories in your archive's `books/` folder.
@@ -174,6 +198,17 @@ The manuscript is read-only in Prosaic — edit your chapters, not the manuscrip
174198
| focus mode | hidden | hidden |
175199
| reader mode | hidden | hidden |
176200

201+
## Status Bar
202+
203+
The status bar at the bottom provides real-time information:
204+
205+
- **Save state**: `[+]` (unsaved changes) or `[·]` (saved)
206+
- **Autosave indicator**: `` (idle) or `` (just saved) - files auto-save every 10 seconds
207+
- **Spell check**: `spellcheck:on` or `spellcheck:off` - toggle with `F7`
208+
- **Git status**: Shows current branch and changes (when in a git repository)
209+
- **Word/character count**: Live metrics as you type
210+
- **File type**: Current document type (piece/book/note/draft)
211+
177212
## Themes
178213

179214
- **Prosaic Light** (default): Warm white background with brick accents
@@ -214,7 +249,7 @@ Example `settings.json`:
214249

215250
```json
216251
{
217-
"app_version": "1.2.1",
252+
"app_version": "1.5.1",
218253
"setup_complete": true,
219254
"active_profile": "default",
220255
"profiles": {
@@ -223,6 +258,8 @@ Example `settings.json`:
223258
"init_git": true,
224259
"git_remote": "git@github.com:you/writing.git",
225260
"theme": "light",
261+
"spell_lang": "en_US",
262+
"spell_check": true,
226263
"last_file": "/Users/you/Prosaic/pieces/2026-03-03-example.md"
227264
}
228265
}
@@ -234,7 +271,14 @@ Example `settings.json`:
234271
```
235272
~/Prosaic/ # Default archive (configurable)
236273
pieces/ # Pieces with preloaded markdown frontmatter
237-
books/ # Long-form projects with Outline already open
274+
2026-05-01-my-piece.md
275+
books/ # Long-form projects (folder-based)
276+
my-book/
277+
chapters/ # Individual chapter files
278+
chapter-one.md
279+
chapter-two.md
280+
chapters.md # Chapter reading order
281+
manuscript.md # Auto-compiled (read-only)
238282
*.md # Drafts (loose files in root)
239283
notes.md # Quick notes with auto date headers
240284
metrics.json # Daily statistics for archival and display

0 commit comments

Comments
 (0)