giers10/textDB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with new AI features and enhancements

Browse Source
This commit is contained in:
Victor Giers
2026-03-14 00:35:14 +01:00
parent 5db45375f3
commit 627d98c199
1 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -1,16 +1,19 @@
# TextDB
TextDB is a **non-destructive**, completely offline, local-first text editor with built-in Markdown preview **and local AI conversion**. Its core promise is simple: your edits never overwrite your history. Every manual save is immutable and append-only, and autosaves are kept as a separate draft layer. It can also convert plain text to Markdown using a local Ollama model (recommended: `ministral:3b`). No accounts, no telemetry, no remote fonts, and no outside network calls.
TextDB is a **non-destructive**, completely offline, local-first text editor with built-in Markdown preview and local AI writing tools. Its core promise is simple: your edits never overwrite your history. Every manual save is immutable and append-only, and autosaves are kept as a separate draft layer. With a local Ollama model (recommended: `ministral:3b`), it can convert plain text to Markdown, proofread, summarize, translate, rewrite, change style, or run a custom instruction against a whole text or a selected passage. No accounts, no telemetry, no remote fonts, and no outside network calls.
## Features
- Non-destructive editing: immutable manual saves + safe autosaved drafts.
- Version history panel with quick restore.
- Markdown preview mode with split view.
- Convert plain text to Markdown manually or via local Ollama (recommended model: `ministral:3b`).
- Markdown preview mode with split view, printable output, clickable links, and automatic raw URL detection.
- Local AI tools via Ollama for Markdown conversion, proofreading, summarizing, translation, rewriting, style changes, and custom prompts.
- AI edits can run on the whole text or just the selected part, and results are written back as drafts.
- In-document search with Cmd/Ctrl+F, result highlighting, and next / previous navigation.
- Live document stats in the footer: characters, words, sentences, and estimated tokens.
- Sort your texts in nested folders with expandable tree; move items around via right-click.
- Open/import `.txt` and `.md` files; export to `.txt` or print / `.pdf`.
- Settings for theme, text size, and optional display of line numbers in the textarea.
- Open/import text files from the file picker or system “Open With”; export to `.txt`, export the database, or print / `.pdf`.
- Settings for theme, text size, line numbers, split view, Ollama connection, and editable AI prompt templates.
## Use cases
@@ -19,6 +22,7 @@ TextDB is a **non-destructive**, completely offline, local-first text editor wit
- **Research notes**: maintain evolving notes with an audit trail of changes.
- **Sensitive drafts**: keep local-only writing with immutable history and zero cloud sync.
- **Prompt or snippet library**: store and iterate on reusable text safely.
- **Offline writing assistant**: run local AI edits without sending text to external services.
## Tech stack
@@ -40,12 +44,13 @@ npm install
npm run tauri dev
```
For AI based text-to-markdown conversion, install Ollama: `https://ollama.com`
For local AI tools, install Ollama: `https://ollama.com`
## Autosave + versioning behavior
- Typing triggers a debounced autosave (~600ms) that writes to the draft record.
- Manual saves (Cmd/Ctrl+S or the button) append a new version and clear any draft.
- AI edits preserve the current text state first when needed, then write the AI result back as a new draft.
- Autosave only overwrites the single draft row; manual versions are never overwritten.
- History shows all manual versions plus the current draft (if any).
@@ -54,4 +59,4 @@ For AI based text-to-markdown conversion, install Ollama: `https://ollama.com`
- SQLite is loaded via `Database.load("sqlite:text.db")`.
- The database file is stored in the Tauri app data directory.
- The app is fully offline by design: no telemetry, no external fonts, no CDNs.
- UI settings (theme, text size, line numbers, sidebar + folder collapse state, last selected text) are stored in localStorage.
- UI settings (theme, text size, line numbers, split view, sidebar + folder collapse state, last selected text, and AI prompt templates) are stored in localStorage.