talk about setup
[tt-rss-micropub.git] / README.rst
1 **************************
2 Micropub for Tiny Tiny RSS
3 **************************
4
5 A plugin for the `Tiny Tiny RSS <https://tt-rss.org/>`_ feed reader to post
6 comments to blog posts via the `Micropub API <https://www.w3.org/TR/micropub/>`_.
7
8 After registering an identity in the preferences, a comment form is shown
9 below each post.
10 You can comment on the blog post and submit the reply to your blog without
11 ever leaving TT-RSS.
12
13
14 .. note:: The micropub plugin does currently not work in
15           "combined feed display mode".
16
17 Screenshot: http://fotos.cweiske.de/screenshots/2017-05-30%20tt-rss%20micropub%20primetime.png
18
19 =====
20 Setup
21 =====
22 First install it into your tt-rss instance::
23
24     $ cd /path/to/tt-rss/plugins.local
25     $ git clone https://git.cweiske.de/tt-rss-micropub.git micropub
26
27 Now enable the "micropub" plugin in the tt-rss preferences.
28
29 After reloading the preferences, a new accordion "Micropub" will be available
30 in the "Preferences" tab.
31 Click on it, enter your homepage URL in "Add new identity" and click "Authorize".
32
33 If at least one identity has been added, posts in tt-rss have a
34 "Reply to this post" section at the bottom.
35
36
37 =====================
38 About tt-rss-micropub
39 =====================
40
41 Source code
42 ===========
43 The source code is available from https://git.cweiske.de/tt-rss-micropub.git
44 or the `mirror on github`__.
45
46 __ https://github.com/cweiske/tt-rss-micropub
47
48
49 License
50 =======
51 The plugin is licensed under the `AGPL v3 or later`__.
52
53 __ http://www.gnu.org/licenses/agpl.html
54
55
56 Author
57 ======
58 tt-rss-micropub was written by `Christian Weiske`__.
59
60 __ http://cweiske.de/