Namespace the plugin

[rbdr/nota.nvim] / README.md

diff --git a/README.md b/README.md
index 520345ca130c59495da9f5021c72f4e1fd951ffb..87238ad1cdb8d4c887554452cae544b4dcdda4e6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,10 +10,12 @@ The minimal setup doesn't require any configuration, and sets the default paths
 
 ```lua
 require('lazy').setup({
 
 ```lua
 require('lazy').setup({

-    'git@git.sr.ht:~rbdr/nota.nvim',
+    'https://git.sr.ht/~rbdr/nota.nvim',

 })
 ```
 
 })
 ```
 

+This plugin has an optional dependency: [fzf-lua][fzf-lua].
+

 By default, nota adds keybinds that might not suit your style or conflict with other plugins. You can disable them with the `default_keybinds` option.
 
 ```lua
 By default, nota adds keybinds that might not suit your style or conflict with other plugins. You can disable them with the `default_keybinds` option.
 
 ```lua


@@ -67,8 +69,6 @@ require('lazy').setup({
 })
 ```
 
 })
 ```
 

-If the default directories don't work for you, you can override them as well:
-

 ## Default Keybinds
 
 ### Opening Notes
 ## Default Keybinds
 
 ### Opening Notes


@@ -77,18 +77,23 @@ If the default directories don't work for you, you can override them as well:
 - `<leader>om`, `:NotaOpenMonthlyNote`, Opens this month's monthly note.
 - `<leader>os`, `:NotaOpenSeasonalNote`, Opens this season's seasonal note.
 - `<leader>oy`, `:NotaOpenYearlyNote`, Opens this year's yearly note.
 - `<leader>om`, `:NotaOpenMonthlyNote`, Opens this month's monthly note.
 - `<leader>os`, `:NotaOpenSeasonalNote`, Opens this season's seasonal note.
 - `<leader>oy`, `:NotaOpenYearlyNote`, Opens this year's yearly note.

-- `<leader>on`, `:NotaOpenNote`, Opens an arbitrary note.
+- `<leader>on`, `:NotaOpenNote`, Opens an arbitrary note. (Requires [fzf-lua][fzf-lua])
+- `<leader>N`, `:NotaOpenNextNote`, Opens the next periodic note. (eg. tomorrow or next year)
+- `<leader>P`, `:NotaOpenPreviousNote`, Opens the previous periodic note. (eg. yesterday or last week)

 
 ### Task Views
 - `<leader>oa`, `:NotaOpenAgenda`, Opens the agenda window with this week's tasks.
 - `<leader>oo`, `:NotaOpenOpen`, Opens a window that lets you navigate through all open tasks.
 
 ### Task Views
 - `<leader>oa`, `:NotaOpenAgenda`, Opens the agenda window with this week's tasks.
 - `<leader>oo`, `:NotaOpenOpen`, Opens a window that lets you navigate through all open tasks.

-- `<leader>oj`, `:NotaOpenJournal`, Opens a window that lets you search completed tasks to find journal entries.
+- `<leader>oO`, `:NotaOpenOpenImportant`, Opens a window that lets you navigate through all open important tasks.
+- `<leader>oj`, `:NotaOpenJournal`, Opens a window that lets you search completed tasks to find journal entries. (Requires [fzf-lua][fzf-lua] and ripgrep)

 
 ### Task Handling Commands
 - `<leader>t`, `:NotaToggleTask`, Toggles completion state of the task under the cursor.
 
 ### Task Handling Commands
 - `<leader>t`, `:NotaToggleTask`, Toggles completion state of the task under the cursor.

+- `<leader>st`, `:NotaToggleTaskImportance`, Toggles importance state of the task under the cursor. (- [ ] is a regular task, * [ ] is an important task)

 - `<leader>it`, `:NotaInsertTask`, Inserts a task at cursor location.
 - `<leader>ct`, `:NotaCaptureTask`, Captures a new task into the inbox.
 - `<leader>Tt`, `:NotaTagTask`, Adds a tag to the current task.
 - `<leader>it`, `:NotaInsertTask`, Inserts a task at cursor location.
 - `<leader>ct`, `:NotaCaptureTask`, Captures a new task into the inbox.
 - `<leader>Tt`, `:NotaTagTask`, Adds a tag to the current task.

+- `<leader>Rt`, `:NotaRemoveTagTask`, Removes a tag from the current task.

 - `<leader>rt`, `:NotaRescheduleTaskToday`, Reschedules the task under the cursor to today.
 - `<leader>rT`, `:NotaRescheduleTaskTomorrow`, Reschedules the task under the cursor to tomorrow.
 - `<leader>rs`, `:NotaRescheduleTaskSomeday`, Reschedules the task under the cursor to someday.
 - `<leader>rt`, `:NotaRescheduleTaskToday`, Reschedules the task under the cursor to today.
 - `<leader>rT`, `:NotaRescheduleTaskTomorrow`, Reschedules the task under the cursor to tomorrow.
 - `<leader>rs`, `:NotaRescheduleTaskSomeday`, Reschedules the task under the cursor to someday.


@@ -101,3 +106,5 @@ If the default directories don't work for you, you can override them as well:
 ### Plan Handling Commands
 - `<leader>op`, `:NotaOpenPlan`, Opens the current plan file.
 - `<leader>cp`, `:NotaCapturePlan`, Captures a new plan and archives the current one.
 ### Plan Handling Commands
 - `<leader>op`, `:NotaOpenPlan`, Opens the current plan file.
 - `<leader>cp`, `:NotaCapturePlan`, Captures a new plan and archives the current one.

+
+[fzf-lua]: https://github.com/ibhagwan/fzf-lua