Skip to content

Commit a4eb6be

Browse files
committed
feat: improve README with accurate usage examples and features
- Replace generic markdown examples with specific app functionality - Add real-world usage scenarios (meeting notes, code snippets) - Update keyboard shortcuts to match actual app shortcuts - Verify and update advanced features based on code analysis - Include accurate details like auto-save timing (300ms debounce) - Showcase multiple notes management and search capabilities - Remove claims about features that don't exist (like fullscreen mode) - Add specific details like word/character count location and inline title editing All features and examples now accurately reflect the actual app functionality.
1 parent 3cdb652 commit a4eb6be

File tree

1 file changed

+38
-21
lines changed

1 file changed

+38
-21
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -44,45 +44,62 @@ npm run dev
4444

4545
---
4646

47-
## πŸ“š Usage Examples
47+
## πŸ“š What You Can Do
4848

49-
```markdown
50-
# Heading 1
51-
52-
**Bold text** and *italic text*
49+
**πŸ“ Multiple Notes Management**
50+
```
51+
β€’ Create unlimited notes with custom titles
52+
β€’ Auto-save as you type (300ms debounce)
53+
β€’ Switch between notes instantly
54+
β€’ Delete notes you no longer need
55+
```
5356

54-
- Bullet points
55-
- [ ] Todo item
56-
- [x] Done item
57+
**⚑ Live Markdown Preview**
58+
```markdown
59+
# Meeting Notes - Project Alpha
5760

58-
[Links](https://example.com)
59-
`inline code`
60-
```
61+
## Action Items
62+
- [x] Review design mockups
63+
- [ ] Schedule client call
64+
- [ ] Update project timeline
6165

66+
## Code Snippets
6267
```javascript
63-
// Code block with syntax highlighting
64-
function greetUser(name) {
65-
return `Hello, ${name}!`;
66-
}
68+
const handleSubmit = async (data) => {
69+
const response = await api.post('/notes', data);
70+
return response.data;
71+
};
6772
```
6873

74+
**🎨 Rich Formatting Support**
75+
- **Bold**, *italic*, ~~strikethrough~~ text
76+
- Tables with proper styling
77+
- Blockquotes with custom borders
78+
- External links (open in new tabs)
79+
- Syntax-highlighted code blocks
80+
6981
---
7082

7183
## 🎨 Advanced Features
7284

73-
* Word & character count
74-
* Fullscreen mode
75-
* Customizable note titles
76-
* Search notes
85+
* **Real-time word & character count** (shown in editor footer)
86+
* **Search notes** with live filtering (Ctrl+K to focus)
87+
* **Customizable note titles** (click to edit inline)
88+
* **Auto-save with debounce** (300ms delay)
89+
* **Sidebar toggle** for distraction-free writing
90+
* **Split-view controls** (toggle editor/preview panels)
7791

7892
---
7993

8094
## ⌨️ Keyboard Shortcuts
8195

8296
* `Ctrl+N` β€” New note
83-
* `Ctrl+S` β€” Save note
97+
* `Ctrl+S` β€” Save note (auto-saves anyway)
8498
* `Ctrl+D` β€” Toggle dark/light mode
85-
* `F11` β€” Fullscreen
99+
* `Ctrl+B` β€” Toggle sidebar
100+
* `Ctrl+P` β€” Toggle preview
101+
* `Ctrl+E` β€” Toggle editor
102+
* `Ctrl+K` β€” Search notes
86103

87104
---
88105

0 commit comments

Comments
Β (0)