diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6a9e93 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# qutebrowser-readability + +Userscript that executes [python-readability](https://github.com/buriy/python-readability) on current page and opens the summary as new tab. + +## Install + +1. Install `readability-lxml` using pip or system package manager: +```bash +pip2 install readability-lxml +``` +2. Place the script at `~/.local/share/qutebrowser/userscripts/readability` + + +## Usage + +``` +:spawn --userscript readability + +``` + +## Example + +![example](qutebrowser-readability.png) \ No newline at end of file diff --git a/qutebrowser-readability.png b/qutebrowser-readability.png new file mode 100644 index 0000000..8b8c3f8 Binary files /dev/null and b/qutebrowser-readability.png differ