From 683e3500d224b20d59ce461e060140fd9f85f1c0 Mon Sep 17 00:00:00 2001 From: Nicolas Petton Date: Mon, 22 Feb 2021 11:31:52 +0100 Subject: Add section on usage in the readme --- readme.org | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/readme.org b/readme.org index 883ae5f..ced0d91 100644 --- a/readme.org +++ b/readme.org @@ -12,7 +12,7 @@ It is easy to miss backlinks when they are not always visible with the main cont By making them an integral part of the org buffer, backlinks also become more powerful. You could for instance make a sparse tree—see =org-sparse-tree= — to filter the contents of a note and its backlinks at the same time. -* Setup +* Setup & usage To setup nroam for all =org-mode= buffer, evaluate the following: @@ -20,6 +20,9 @@ To setup nroam for all =org-mode= buffer, evaluate the following: (add-hook 'org-mode-hook #'nroam-mode) #+end_src +The linked references section will be updated after each buffer save. +It can also be manually updated by typing =C-c C-c= anywhere in the linked references section. + * Warning This package is in its infancy. Be careful when using it as it modifies your =org-mode= buffers—it should not modify your files though. Backup your data often. -- cgit v1.2.3-54-g00ecf