Add README.md

This commit is contained in:
Gergely Polonkai 2015-01-28 13:47:15 +01:00
commit 0d3af577a5
1 changed files with 21 additions and 0 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
Link listing for Zim
====================
List all links in your [Zim](http://zim-wiki.org/) notebook, prefixed
with an `E` for existing or `M` for missing pages.
Installation
------------
Download/clone this repository in your `$XDG_DATA_HOME/zim/plugins`
(usually it is in `~/.local/share`).
Usage
-----
Open a terminal and enter
$ zim --plugin linklist --notebook <notebook name>
Add `--missing-only` or `--existing-only` to list only dangling or
existing pages.