diff options
| author | HumanEntity <human_entity@icloud.com> | 2023-12-25 13:33:15 +0100 |
|---|---|---|
| committer | HumanEntity <human_entity@icloud.com> | 2023-12-25 13:33:15 +0100 |
| commit | b79f2707309c20f2834008b1ea0cfcad89ba3978 (patch) | |
| tree | ab2b6996c04e4c6d7f731f647f9f5249e0fc564e /README.md | |
| parent | f94d9d4419e3a32ecee4410619c34a9433ca996d (diff) | |
| download | simple-denote.nvim-b79f2707309c20f2834008b1ea0cfcad89ba3978.tar.gz | |
Updated README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 48 insertions, 3 deletions
@@ -7,9 +7,54 @@ ```lua { - "HumanEntity/denote.nvim", - build = "mkdir -p ~/.denote/", + "HumanEntity/denote.nvim", + build = "mkdir -p ~/.denote/", + cmd = "Denote", } ``` -This takes care of installing and creating note directory for `denote`. Denote has no external dependencies but I recommend you use `telescope-ui-select.nvim` plugin for better ui. +This takes care of installing, lazy loading and creating note directory for `denote`. Denote has no external dependencies but I recommend you use `telescope-ui-select.nvim` plugin for better ui. + +# Usage + +## `Denote` command + +### Creating notes + +To create use `note` sub command. It will will prompt for note name and tags. Tags are space separated. + +### Searching for notes + +To search for note use `search` sub command. It will prompt for date in YEAR MONTH DAY format and name. + +## `api` way + +To use `denote` api either require it using + +```lua +local api = require("denote.api") +``` + +or use `denote.api` + +```lua +local api = require("denote").api +``` + +One thing to note is that you can use the api just like the command just don't pass any argument to function. + +### Creating notes + +To create the note use `note` function. + +```lua +api.note(name, tags) +``` + +### Searching for notes + +To search for note use `search` function. `date` is table with year, month and day field. + +```lua +api.search(date,name) +``` |
