From e7e11a7bdb0dab973980baf0bb85ccac4341139b Mon Sep 17 00:00:00 2001 From: HumanEntity Date: Fri, 22 Dec 2023 21:06:18 +0100 Subject: Updated README --- README.md | 15 +++++++++++++++ README.norg | 10 ++++++++++ 2 files changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..20d5677 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# `denote.nvim` + +`denote.nvim` is a plugins for creating notes without any external dependencies. Main inspiration for this project was emacs package called `Denote`. + + +# Installation + +```lua + { + "HumanEntity/denote.nvim", + build = "mkdir -p ~/.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. diff --git a/README.norg b/README.norg index 6aee588..e27ec35 100644 --- a/README.norg +++ b/README.norg @@ -1,2 +1,12 @@ * `denote.nvim` `denote.nvim` is a plugins for creating notes without any external dependencies. Main inspiration for this project was emacs package called `Denote`. + +* Installation + @code lua + { + "HumanEntity/denote.nvim", + build = "mkdir -p ~/.denote/" + } + @end + + 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. -- cgit v1.2.3