aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9e0788b..291e920 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
# simple-denote.nvim
-The plugin provides a command `:Denote note` that creates a new note with a filename similar to the emacs `denote` package. For example: `20240601T174946--how-to-tie-a-tie__lifeskills_clothes.md`.
+This plugin provides a command `:Denote note` that prompts for a title and tags, then creates a new file using the emacs `denote` package file-naming scheme:
-There is no support for frontmatter, signatures, or any other denote features because I don't use them. I just like the file-naming scheme.
+`DATE==SIGNATURE--TITLE__KEYWORDS.EXTENSION`
+
+For example:
+1. `20240601T174946--how-to-tie-a-tie__lifeskills_clothes.md`
+2. `20240601T180054--i-have-no-tags.md`
+3. `20240601T193022__im_only_tags.md`
+4. `20240601T200121.md`
+5. `20240601T213392=1a1--i-have-a-signature__denote_coolstuff.md` (Not yet implemented)
+
+There is no support for frontmatter or any other denote features. I just like the file-naming scheme.
You can read more about the denote file-naming scheme here:
https://protesilaos.com/emacs/denote#h:4e9c7512-84dc-4dfb-9fa9-e15d51178e5d