Update documentation for 0.1.1 release

chipsenkbeil · Nov 16, 2024 · 85e76e0 · 85e76e0
1 parent 17f85ab
commit 85e76e0
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 18 deletions.
diff --git a/DOCS.org b/DOCS.org
@@ -2,29 +2,30 @@
 
   Port of [[https://www.orgroam.com/][Org-roam]] to [[https://neovim.io/][neovim]] using [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode]].
 
-  Requires *neovim 0.9.2+*.
+  Requires *neovim 0.9.4+*.
 
 ** Installation
 
-   This plugin depends on [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode/orgmode]] [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.4][0.3.4]] or newer.
+   This plugin depends on [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode/orgmode]] [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.7][0.3.7]] or newer.
 
    It is recommended to install and maintain the latest version of orgmode,
    or lock into the commit that this plugin needs, which is illustrated below.
 
    | Org Roam Version | Orgmode Version |
    |------------------+-----------------|
-   | 0.1.0            | 0.3.4           |
+   | [[https://github.com/chipsenkbeil/org-roam.nvim/releases/tag/0.1.1][0.1.1]]            | [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.7][0.3.7]]           |
+   | [[https://github.com/chipsenkbeil/org-roam.nvim/releases/tag/0.1.0][0.1.0]]            | [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.4][0.3.4]]           |
 
 *** lazy.nvim
 
     #+begin_src lua
     {
       "chipsenkbeil/org-roam.nvim",
-      tag = "0.1.0",
+      tag = "0.1.1",
       dependencies = {
         {
           "nvim-orgmode/orgmode",
-          tag = "0.3.4",
+          tag = "0.3.7",
         },
       },
       config = function()
@@ -40,11 +41,11 @@
     #+begin_src lua
     use {
       "chipsenkbeil/org-roam.nvim",
-      tag = "0.1.0",
+      tag = "0.1.1",
       requires = {
         {
           "nvim-orgmode/orgmode",
-          tag = "0.3.4",
+          tag = "0.3.7",
         },
       },
       config = function()
@@ -1102,12 +1103,12 @@
 
 ** Select Buffer
 
-   When within the /select buffer/, you can filter the list by typing. 
+   When within the /select buffer/, you can filter the list by typing.
    - Press =<Enter>= to confirm the selection
    - Press =<S-Enter>= to confirm the typed title if no selection is available
      (e.g. when using [[#org-roam-api-find-node][Find Node]])
-   - Press =<C-n>= or =<Down>= to select the next item in the list 
-   - Press =<C-n>= or =<Up>= to select the next item in the list 
+   - Press =<C-n>= or =<Down>= to select the next item in the list
+   - Press =<C-n>= or =<Up>= to select the next item in the list
 
 *** Disable nvim-cmp completion in select buffer
 
@@ -2733,7 +2734,19 @@
 
 * Changelog
 
-  TODO
+** 0.1.1
+
+1. =fix= orgmode database now refreshes on roam node creation (#64)
+2. =feat= selection dialog buffer now has a filetype of *org-roam-select* (#59)
+3. =fix= type error when specifying *config.bindings = false* (#57)
+4. =feat= allow to add more org file locations via an *org_files* list (#42)
+5. =chore= add documentation for select buffer (#53)
+6. =fix= dailies extension now opens the calendar at the current day (#48)
+7. =fix= orgmode filetype is now detected open first opening buffer using find api
+8. =feat= new keybinding *prefix* option to support changing across all keybindings (#46)
+9. =fix= selection UI no longer wraps lines that are too long (#45)
+10. =chore= unify formatting by providing a *.editorconfig* and adding stylua action (#44)
+11. =chore= doc now recommends users specify tag for org-roam plugin
 
 * Credits
 

diff --git a/README.org b/README.org
@@ -5,22 +5,23 @@
 
 Port of [[https://www.orgroam.com/][Org-roam]] to [[https://neovim.io/][neovim]] using [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode]].
 
-Requires *neovim 0.9.2+*.
+Requires *neovim 0.9.4+*.
 
 ** Videos
 
 #+HTML: <a href="https://youtu.be/02lE-yGJWvc"><img src="https://img.youtube.com/vi/02lE-yGJWvc/maxresdefault.jpg" width=300></a>
 
 ** Installation
 
-   This plugin depends on [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode/orgmode]] [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.4][0.3.4]] or newer.
+   This plugin depends on [[https://github.com/nvim-orgmode/orgmode][nvim-orgmode/orgmode]] [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.7][0.3.7]] or newer.
 
    It is recommended to install and maintain the latest version of orgmode,
    or lock into the commit that this plugin needs, which is illustrated below.
 
    | Org Roam Version | Orgmode Version |
    |------------------+-----------------|
-   | 0.1.0            | 0.3.4           |
+   | [[https://github.com/chipsenkbeil/org-roam.nvim/releases/tag/0.1.1][0.1.1]]            | [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.7][0.3.7]]           |
+   | [[https://github.com/chipsenkbeil/org-roam.nvim/releases/tag/0.1.0][0.1.0]]            | [[https://github.com/nvim-orgmode/orgmode/releases/tag/0.3.4][0.3.4]]           |
 
 *** lazy.nvim (recommended)
 
@@ -30,11 +31,11 @@ Requires *neovim 0.9.2+*.
     #+begin_src lua
     {
       "chipsenkbeil/org-roam.nvim",
-      tag = "0.1.0",
+      tag = "0.1.1",
       dependencies = {
         {
           "nvim-orgmode/orgmode",
-          tag = "0.3.4",
+          tag = "0.3.7",
         },
       },
       config = function()
@@ -61,11 +62,11 @@ Requires *neovim 0.9.2+*.
     #+begin_src lua
     use {
       "chipsenkbeil/org-roam.nvim",
-      tag = "0.1.0",
+      tag = "0.1.1",
       requires = {
         {
           "nvim-orgmode/orgmode",
-          tag = "0.3.4",
+          tag = "0.3.7",
         },
       },
       config = function()