Skip to content

Commit b718f62

Browse files
committed
add disclaimer and revise todo list
1 parent cc1d612 commit b718f62

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
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.
3+
14
<h1><img src="./src/icon.svg" height="24px" width="24px" /> NoteKeeper</h1>
25

36
![Mozilla Add-on](https://img.shields.io/amo/v/newtab-notes@semanticdata) ![Add-on rating](https://img.shields.io/amo/rating/newtab-notes@semanticdata) ![Add-on downloads](https://img.shields.io/amo/dw/newtab-notes@semanticdata) ![Add-on users](https://img.shields.io/amo/users/newtab-notes@semanticdata) ![License](https://img.shields.io/github/license/semanticdata/firefox-new-tab-notes)
47

5-
[NoteKeeper](https://addons.mozilla.org/en-US/firefox/addon/notekeeper/) is a Firefox extension that transforms the new tab into a minimalist, auto-saving text editor. It now comes with a new sidebar companion! If you are curious, go check out the [demo](https://semanticdata.github.io/notekeeper/).
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.
69

710
<a href="https://addons.mozilla.org/en-US/firefox/addon/notekeeper/">
811
<img src="https://raw.githubusercontent.com/semanticdata/text-revealer-firefox-extension/master/firefox.png" alt="firefox addon" /></a>
912

10-
## ✨ Features
13+
## What it does
1114

1215
> [!NOTE]
13-
> These need to be verified after our v2 update.
16+
> Feature checklist pending v2 verification.
1417
15-
- [ ] Auto-saves content after every keystroke
16-
- [ ] Integrated with Firefox Sync - access your notes across browser instances
17-
- [ ] Integrated with [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)
18-
- [ ] Works offline with browser sync support ([Firefox Sync](https://www.mozilla.org/en-US/firefox/features/sync/), [Chrome Sync](https://support.google.com/chrome/answer/185277))
19-
- [ ] Dark/Light themes with system preference detection
20-
- [ ] Responsive design that works across devices
21-
- [ ] Sidebar companion for quick access
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)
2224

2325
<!--
24-
## 🖼️ Screenshots
26+
## Screenshots
2527
2628
| ![light-mode](./screenshot.png) | ![dark-mode](./screenshot-dark.png) |
2729
| :-----------------------------: | :---------------------------------: |
2830
-->
2931

30-
## 💜 Acknowledgments
32+
## Acknowledgments
3133

3234
This extension is based on [Tab Notes](https://github.com/nsht/tab_notes). It hadn't received updates in over 6 years last time I checked.
3335

34-
## © License
36+
## License
3537

3638
Available under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)