From d881a511470d8c7954f2871ae0ec1c8b106f3983 Mon Sep 17 00:00:00 2001 From: triet Date: Sun, 28 Oct 2018 12:34:27 +0700 Subject: [PATCH] Update readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 624e98b..b290d38 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # pdfjs -Electron app for viewing PDF with simple vim binding +Electron app for viewing PDF with simple vim binding. + +Using: +- Electron https://github.com/electron/electron +- PDF.js https://mozilla.github.io/pdf.js/ + +Update keyboard shortcuts: +- PDF.js support many keyboard shortcuts https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions#what-are-the-pdfjs-keyboard-shortcuts, but unfortunately does not support j/k to move up/down. +- Switch old `j`/`k` (page down/page up) to `d/u` +- Implement new keybind `j`/`k` to move `down`/`up` + +# Install + +``` +npm install + +npm start +```