|
1 | | -> [!IMPORTANT] |
2 | | -> We're currently extracting the sidebar note editor into its own extension. Some folks want the sidebar feature without the new tab replacement. |
| 1 | +> [!NOTE] |
| 2 | +> NoteKeeper v2 is now available as two separate extensions that sync notes with each other. Install both for the best experience! |
3 | 3 |
|
4 | | -<h1><img src="./src/icon.svg" height="24px" width="24px" /> NoteKeeper</h1> |
| 4 | +<h1><img src="./shared/icon.svg" height="28px" width="28px" /> NoteKeeper</h1> |
5 | 5 |
|
6 | 6 |      |
7 | 7 |
|
8 | | -[NoteKeeper](https://addons.mozilla.org/en-US/firefox/addon/notekeeper/) replaces the new tab page with a simple text editor. Your notes auto-save and sync across devices via Firefox Sync. There's also a sidebar companion if you prefer that. |
| 8 | +[NoteKeeper](https://addons.mozilla.org/en-US/firefox/addon/notekeeper/) replaces the new tab page with a simple text editor. Your notes auto-save and sync across devices via Firefox Sync. The companion [NoteKeeper Sidebar](https://addons.mozilla.org/en-US/firefox/addon/notekeeper-sidebar/) extension adds a sidebar editor that syncs with the new tab version. |
9 | 9 |
|
10 | 10 | <a href="https://addons.mozilla.org/en-US/firefox/addon/notekeeper/"> |
11 | 11 | <img src="https://raw.githubusercontent.com/semanticdata/text-revealer-firefox-extension/master/firefox.png" alt="firefox addon" /></a> |
12 | 12 |
|
13 | 13 | ## What it does |
14 | 14 |
|
15 | | -> [!NOTE] |
16 | | -> Feature checklist pending v2 verification. |
17 | | -
|
18 | | -- [ ] Auto-saves as you type (debounced, not on every keystroke) |
19 | | -- [ ] Syncs notes across devices via Firefox Sync |
20 | | -- [ ] Dark/light theme, follows your system preference |
21 | | -- [ ] Adjustable font size |
22 | | -- [ ] Works offline |
23 | | -- [ ] Sidebar companion (Alt+Shift+N) |
| 15 | +Both extensions share notes via Firefox Sync: |
| 16 | + |
| 17 | +### NoteKeeper (New Tab) |
| 18 | + |
| 19 | +- [x] Auto-saves as you type (debounced, not on every keystroke) |
| 20 | +- [x] Syncs notes across devices via Firefox Sync |
| 21 | +- [x] Dark/light theme, follows your system preference |
| 22 | +- [x] Adjustable font size |
| 23 | +- [x] Works offline |
| 24 | + |
| 25 | +### NoteKeeper Sidebar (Companion) |
| 26 | + |
| 27 | +- [x] All features of NoteKeeper |
| 28 | +- [x] Opens in Firefox sidebar (Alt+Shift+N) |
| 29 | +- [x] Syncs with NoteKeeper (notes appear in both extensions) |
| 30 | +- [x] Keyboard shortcut customization |
| 31 | + |
| 32 | +## Testing Checklist |
| 33 | + |
| 34 | +NoteKeeper (New Tab): |
| 35 | + |
| 36 | +- [x] Open new tab - should show NoteKeeper editor |
| 37 | +- [ ] Type text - should auto-save (status shows "Saved") |
| 38 | +- [x] Toggle theme - dark/light modes work |
| 39 | +- [ ] Adjust font size - slider changes text size |
| 40 | +- [ ] Refresh page - notes persist |
| 41 | +- [ ] Check word count - updates as you type |
| 42 | + |
| 43 | +NoteKeeper Sidebar: |
| 44 | + |
| 45 | +- [ ] Press `Alt+Shift+N` - sidebar opens |
| 46 | +- [ ] Type text in sidebar - should auto-save |
| 47 | +- [x] Toggle theme in sidebar - works |
| 48 | +- [ ] Adjust font size in sidebar - works |
| 49 | +- [ ] Open extension options - keyboard shortcut config appears |
| 50 | +- [ ] Change keyboard shortcut - saves successfully |
| 51 | + |
| 52 | +Test Sync Between Extensions: |
| 53 | + |
| 54 | +- [ ] Type in new tab → appears in sidebar |
| 55 | +- [ ] Type in sidebar → appears in new tab |
| 56 | +- [ ] Change theme in new tab → changes in sidebar |
| 57 | +- [ ] Change font size in new tab → changes in sidebar |
| 58 | +- [ ] Open two tabs - both sync notes |
| 59 | +- [ ] Close/reopen new tab - notes restored |
| 60 | +- [ ] Close/reopen sidebar - notes restored |
| 61 | + |
| 62 | +Test Offline Mode: |
| 63 | + |
| 64 | +- [ ] Disconnect internet |
| 65 | +- [ ] Type in new tab - saves (to local storage) |
| 66 | +- [ ] Type in sidebar - saves |
| 67 | +- [ ] Reconnect internet - syncs to Firefox Sync |
| 68 | +- [ ] Notes persist across devices |
| 69 | + |
| 70 | +Test Cross-Tab Sync: |
| 71 | + |
| 72 | +- [ ] Open multiple new tabs |
| 73 | +- [ ] Type in one tab - updates others |
| 74 | +- [ ] Switch between tabs - notes sync |
| 75 | +- [ ] Open sidebar - notes match new tab |
24 | 76 |
|
25 | 77 | <!-- |
26 | 78 | ## Screenshots |
|
0 commit comments