add README

2019-05-01 19:01:08 +02:00
parent d8c4956a22
commit 52c9e61988
1 changed files with 20 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,20 @@
+toggle_sort_titles plugin
+=========================
+
+Plugin for [Tiny Tiny RSS](https://tt-rss.org/) to add a new hotkey to change
+feed sorting.
+
+
+Installation
+------------
+
+- git clone the repository or download a copy in the plugins.local directory of
+  your tt-rss install.
+- Inside tt-rss, go to Configuration and enable the `toggle_sort_titles` plugin
+
+
+Usage
+-----
+
+Just press `T` to toggle sort order.
+