Skip to content

Commit

Permalink
Update README with Related notes
Browse files Browse the repository at this point in the history
  • Loading branch information
rsandz committed Feb 19, 2024
1 parent bcdb457 commit 30fe9f7
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,30 @@ This plugin for [Joplin](https://joplinapp.org/) adds a simple calendar which al
- The plugin includes a **calendar** and a **notes list**.

## 📆 Calendar

- Clicking on a calendar date shows the notes created or updated on that date.
- Clicking on the '<' and '>' buttons above the calendar moves between months.
- Clicking on the '<' and '>' buttons above the calendar *while holding `ctrl`* moves between years.
- Clicking on the '<' and '>' buttons above the calendar _while holding `ctrl`_ moves between years.
- Calendar dates have dots beneath them indicating the number of notes written on that day.
- Each dot represents 2 notes created, up to a maximum of 4 dots.

> [!Tip]
> The create date and updated date for a note can be manually change by clicking on the "🛈" button.
## 🗒️ Notes List
- The notes list shows notes created and updated on the specified date.
- Showing updated notes can be disabled in the settings.

- The notes list shows notes created on the specified date.
- The notes list can show notes updated on the specified date.
- This must be enabled in the settings.
- The notes list can show notes related to the specified date. These are notes that have the date in the title of the note.
- This must be enabled in the settings.
- The Joplin date format is used when searching for related notes.
- Navigate to the notes by clicking on the titles in the notes list.
- Clicking on the '<' and '>' buttons above the notes list moves days.
- Clicking on the '<' and '>' buttons above the notes list *while holding `ctrl`* moves between days with notes.
- Clicking on the '<' and '>' buttons above the notes list _while holding `ctrl`_ moves between days with notes.
- Clicking the `today` button brings back the calendar focus to the current day.
- Notes can be sorted by time of creation, or alphabetically. The sort direction can also be changed.


## ⌨️ Keyboard Shortcuts

### Joplin Wide
Expand All @@ -47,6 +52,11 @@ This plugin for [Joplin](https://joplinapp.org/) adds a simple calendar which al

- Use up and down arrow keys to select notes.

## 🛑 Limitations

- Related notes is still an experimental feature - it will negatively impact performance with larger note books.
- When searching for the nearest note with Related Notes ON, only related notes within the closest 120 days will be checked.

# ⚙️ Development

## Building the plugin
Expand Down

0 comments on commit 30fe9f7

Please sign in to comment.