]> Sergey Matveev's repositories - zk.zsh.git/blobdiff - README
Caching
[zk.zsh.git] / README
diff --git a/README b/README
index 32abec060cb87c744db0d1e69bcc70e9fbef8cf4..206b6dd949ec80ec0761d014eb01aab822c00ecd 100644 (file)
--- a/README
+++ b/README
@@ -20,23 +20,24 @@ zk.zsh -- zettelkästen/wiki/static website helper/generator
 * Ordinary grep, git-jump or similar tools can be used to search
   and quickly open results in the editor
 
-The only thing Vim lacks there is ability to tell who
-backreferences to the specified page. zk.zsh can be used to show
-what pages backreferences to specified page and what pages are
-referenced by it:
+The only thing Vim lacks there is ability to tell who backlinks
+to the specified page. zk.zsh can be used to show what pages
+backlinks to specified page and what pages are referenced by it:
     $ zk.zsh links some/page
     Another/Page
     SomePage
     $ zk.zsh backs some/page
     [...]
 That can be used to make categories and tags on notes. If note
-contains a link to category/tag, then it will be backreferenced.
-
-Currently it does not use any kind of database or cache. It
-parses all files every time.
+contains a link to category/tag (even an empty file), then it
+will be backlinked.
 
     $ zk.zsh htmls path/to/dir
 Will convert all your notes to HTMLs with properly created links
-to other pages. It also will include all backreference links in
-them. Each directory will also contain Index page with links to
-all existing pages in current directory and to subdirectories.
+to other pages. It also will include all backlinks in them. Each
+directory will also contain index page with links to all
+existing pages in current directory and to subdirectories.
+
+If ZK_CACHE environment variable contains path to some
+directory, then it will keep caching information for speeding up
+the processes in it. Look for CACHE file for more information.