diff --git a/readme.md b/readme.md index 56b4ad7..1816585 100644 --- a/readme.md +++ b/readme.md @@ -2,15 +2,23 @@ View your notes as a static html site. +![](./screenshot.png) + ## Install -0. Install [Pandoc](https://pandoc.org/index.html) +0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq) + + On arch: + ``` + # pacman -S pandoc yq + ``` + 1. Run `make install` as root ## Usage ``` -notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]] +$ notes2web NOTES_DIRECTORY_1 [NOTES_DIRECTORY_2 [...]] ``` The command will generate and place html files in your notes directory. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..242bda0 Binary files /dev/null and b/screenshot.png differ