diff --git a/README.md b/README.md new file mode 100644 index 0000000..f33f55d --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Waypoint + +Calendar, recent files, and custom bookmarks sidebar for Obsidian. + +## Features + +- **Calendar panel** — month grid with clickable days, week numbers, period indicators (day/week/month/quarter/year) +- **Recent files** — track recently opened/edited files +- **Favorites** — custom bookmarks with groups, icons, and rename + +## Commands + +| Command | Default Hotkey | +|---|---| +| Go to daily note | `Ctrl+Shift+Alt+D` | +| Go to weekly note | `Ctrl+Shift+Alt+W` | +| Go to monthly note | `Ctrl+Shift+Alt+M` | +| Go to quarterly note | `Ctrl+Shift+Alt+Q` | +| Go to yearly note | `Ctrl+Shift+Alt+Y` | +| Next/Previous daily/weekly/monthly/quarterly/yearly note | — | + +## Installation + +### Via BRAT + +1. Install the [BRAT](https://obsidian.md/plugins?search=brat) plugin +2. Add `https://gitea.mithrilforge.dev/olivier/waypoint` as a Beta Plugin +3. Enable **Waypoint** in Community Plugins + +### Manual + +1. Download the latest release from [Gitea](https://gitea.mithrilforge.dev/olivier/waypoint/releases) +2. Extract `main.js`, `manifest.json`, and `styles.css` to `{vault}/.obsidian/plugins/waypoint/` +3. Enable **Waypoint** in Community Plugins \ No newline at end of file diff --git a/manifest.json b/manifest.json index f1dd908..592beed 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { - "id": "waypoint", - "name": "Waypoint", - "version": "1.1.0", + "id": "waypoint-sidebar", + "name": "Waypoint Sidebar", + "version": "1.2.0", "minAppVersion": "0.16.3", "description": "Calendar, recent files, and custom bookmarks sidebar.", "author": "Olivier", diff --git a/package.json b/package.json index a3961ed..a20c2de 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "waypoint", - "version": "1.1.0", + "version": "1.2.0", "description": "Calendar, recent files, and custom bookmarks sidebar.", "main": "main.js", "scripts": {