From b79f2707309c20f2834008b1ea0cfcad89ba3978 Mon Sep 17 00:00:00 2001
From: HumanEntity <human_entity@icloud.com>
Date: Mon, 25 Dec 2023 13:33:15 +0100
Subject: Updated README

---
 README.md   | 51 ++++++++++++++++++++++++++++++++++++++++++++++++---
 README.norg | 12 ------------
 2 files changed, 48 insertions(+), 15 deletions(-)
 delete mode 100644 README.norg

diff --git a/README.md b/README.md
index fe826e1..90bd724 100644
--- a/README.md
+++ b/README.md
@@ -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)
+```
diff --git a/README.norg b/README.norg
deleted file mode 100644
index ac30d0f..0000000
--- a/README.norg
+++ /dev/null
@@ -1,12 +0,0 @@
-* `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