diff --git a/README.md b/README.md new file mode 100644 index 0000000..5ee9caa --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Side Notes + +A Chrome extension (Manifest V3) that gives you one markdown note per web page, available instantly from a side panel. Notes are keyed by the page's normalized URL and persisted locally. + +This project is an experiment in using [OpenSpec](https://openspec.ai) for fully AI-coded projects: all behavior is specified as capability specs under `openspec/`, and changes are proposed, implemented, and archived through the spec-driven workflow. + +## What is it for + +- Jot down notes tied to the page you're viewing, without leaving the tab. +- Open the side panel from the toolbar action or `Ctrl+Shift+N` / `Cmd+Shift+N`. +- Notes autosave as you type and survive browser restarts. +- Browse all saved notes on a dedicated notes-list page, grouped by day like browser history, and jump back to a note's page from it. + +## How to run + +1. Open `chrome://extensions` in Chrome. +2. Enable **Developer mode** (top-right toggle). +3. Click **Load unpacked** and select this repository's root directory. +4. On any page, click the Side Notes toolbar icon (or press the shortcut) to open the side panel and start writing. + +To view all notes, open the notes-list page from within the extension.