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
  20 That's it. Your Tiny Tiny RSS instance is registered at subtome.com now.
  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 subtome
  31
  32 Then enable the plugin in the preferences.
  33
  34 .. note:: To make it easy for everyone, enable the plugin for all
  35           users by adding it to the ``PLUGINS`` configuration in
  36           ``config.php``::
  37
  38             define('PLUGINS', 'auth_internal, note, subtome');
  39
  40 =====
  41 About
  42 =====
  43 The Tiny Tiny RSS SubToMe plugin was written by `Christian Weiske`__
  44 and is licensed under the AGPLv3 or later.
  45
  46 __ cweiske+subtome@cweiske.de