README.rst

   1 ********************************
   2 SubToMe plugin for Tiny Tiny RSS
   3 ********************************
   4
   5 Allows users to register their `Tiny Tiny RSS`__ instance at `subtome.com`__.
   6 Once done, they can subscribe to feeds with only two clicks.
   7
   8 Screenshots are available on the `introductory blog post`__.
   9
  10 __ https://tt-rss.org/
  11 __ https://www.subtome.com/
  12 __ http://cweiske.de/tagebuch/tt-rss-subtome.htm
  13
  14
  15 =====
  16 Usage
  17 =====
  18 #. Go to Tiny Tiny RSS preferences.
  19 #. You'll see a new panel "SubToMe". Click on it.
  20 #. Click the "Add TT-RSS to SubToMe.com" button.
  21
  22    If you want, you can adjust the name before.
  23
  24
  25 ============
  26 Installation
  27 ============
  28 Clone this repository into the ``plugins.local/`` directory of your
  29 TT-RSS folder::
  30
  31     $ cd /path/to/tt-rss/
  32     $ cd plugins.local/
  33     $ git clone git://git.cweiske.de/tt-rss-subtome.git
  34
  35 Then enable the plugin in the preferences.
  36
  37
  38 =====
  39 About
  40 =====
  41 The Tiny Tiny RSS SubToMe plugin was written by `Christian Weiske`__
  42 and is licensed under the AGPLv3 or later.
  43
  44 __ cweiske+subtome@cweiske.de