Skip to content

Commit 4614d38

Browse files
committed
docs: update README for v2.1.0 with new features
1 parent ae02b6d commit 4614d38

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,22 @@
1414

1515
**🌐 [Try it online →](https://kiku-jw.github.io/DocStripper/)** — No installation needed!
1616

17+
**📦 Latest Release:** [v2.1.0](https://github.com/kiku-jw/DocStripper/releases/tag/v2.1.0) — UX enhancements & distribution ready
18+
1719
---
1820

1921
## ✨ Features
2022

2123
-**Fast Clean** — Instant rule-based cleaning
2224
- 🤖 **Smart Clean (Beta)** — AI-powered cleaning with on-device LLM
2325
- 🎚️ **4 Cleaning Temperaments** — Gentle (safe), Moderate, Thorough, Aggressive
26+
- ⚙️ **WebWorker Processing** — Large files processed in background (no UI freezing)
2427
- 🔄 **Side-by-Side Preview** — Compare Original | Cleaned
2528
- 💾 **Settings Persistence** — Your preferences are saved automatically
26-
- 🔒 **100% Private** — All processing happens in your browser
29+
- 🔒 **100% Private** — All processing happens in your browser, works completely offline
30+
- 📡 **Works Offline Badge** — Visual indicator that everything stays on your device
2731
- 📊 **Real-time Statistics** — See exactly what was removed
28-
- 📥 **Download & Copy** — Download cleaned files or copy to clipboard
32+
- 📥 **Batch Download (ZIP)** — Download multiple cleaned files at once
2933
- 🎨 **Dark Theme** — Toggle between light and dark themes
3034
- 📱 **Mobile Responsive** — Works great on mobile devices
3135

@@ -139,21 +143,25 @@ More content.
139143
- ✅ Empty lines
140144
- ✅ Punctuation-only lines (---, ***, ===)
141145
- ✅ Hyphenation fixed (auto-\nmatic → automatic)
146+
- ✅ Preserves paragraph spacing
142147
- ❌ Line merging disabled (preserves formatting)
143148
- ❌ Whitespace normalization disabled
149+
- ❌ Unicode normalization disabled
144150

145151
**Moderate**
146152
- All Gentle features plus:
147153
- ✅ Merges broken lines (protects lists and tables)
154+
- ✅ Preserves paragraph spacing
148155

149156
**Thorough**
150157
- All Moderate features plus:
151158
- ✅ Normalizes whitespace (protects tables)
152-
- ✅ Normalizes Unicode punctuation (smart quotes, dashes)
153-
- ✅ Preserves paragraph spacing
159+
- ✅ Normalizes Unicode punctuation (smart quotes, dashes → ASCII)
160+
- ✅ Preserves paragraph spacing (better readability)
154161

155162
**Aggressive**
156163
- All Thorough features plus:
164+
- ✅ Normalizes Unicode punctuation
157165
- ❌ Removes paragraph spacing (more compact output)
158166

159167
### CLI Flags (defaults ON)
@@ -188,11 +196,25 @@ More content.
188196

189197
## 🔧 Requirements
190198

199+
### Web App
200+
- Modern web browser (Chrome, Firefox, Safari, Edge)
201+
- No installation or dependencies required
202+
- Works completely offline after first load
203+
204+
### CLI Tool
191205
- **Python 3.9+** (for CLI tool)
192206
- **PDF support** (optional): `pdftotext` from poppler-utils
193207

194208
---
195209

210+
## 📝 Changelog
211+
212+
See [RELEASE_NOTES_v2.1.0.md](RELEASE_NOTES_v2.1.0.md) for the latest release notes.
213+
214+
All releases: [GitHub Releases](https://github.com/kiku-jw/DocStripper/releases)
215+
216+
---
217+
196218
## 📝 License
197219

198220
MIT License — see [LICENSE.txt](LICENSE.txt) for details.

0 commit comments

Comments
 (0)