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 __ https://tt-rss.org/
   9 __ https://www.subtome.com/
  10
  11
  12 =====
  13 Usage
  14 =====
  15 #. Go to Tiny Tiny RSS preferences.
  16 #. You'll see a new panel "SubToMe". Click on it.
  17 #. Click the "Add TT-RSS to SubToMe.com" button.
  18
  19    If you want, you can adjust the name before.
  20
  21
  22 ============
  23 Installation
  24 ============
  25 Clone this repository into the ``plugins.local/`` directory of your
  26 TT-RSS folder::
  27
  28     $ cd /path/to/tt-rss/
  29     $ cd plugins.local/
  30     $ git clone git://git.cweiske.de/tt-rss-subtome.git
  31
  32 Then enable the plugin in the preferences.
  33
  34
  35 =====
  36 About
  37 =====
  38 The Tiny Tiny RSS SubToMe plugin was written by `Christian Weiske`__
  39 and is licensed under the AGPLv3 or later.
  40
  41 __ cweiske+subtome@cweiske.de