Skip to content

Commit e8dad3c

Browse files
authored
Update README.md
1 parent d8e711d commit e8dad3c

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# Pelican-toot
22
A Pelican plugin to publish content on Mastodon
33

4-
## THIS IS A VERY EARLY STAGE OF DEVELOPMENT
5-
## DO NOT USE!!
6-
7-
====================================================================================
8-
TEST - TEST - TEST
9-
====================================================================================
10-
114
Hacked from [Pelican-tweet](https://github.com/mpaglia0/Pelican-tweet).
125

136
Needs Python > 3.0
@@ -22,14 +15,27 @@ Then it tries to post all eligible articles to Mastodon and - if post routine re
2215

2316
On every further run it matches the actual articles list with the list in `posted_on_Mastodon.txt` file and posts only new articles (and writes them in `posted_on_Mastodon.txt`).
2417

18+
*Pelican-toot* is at its very first stage of development, but it is already usable in product environments.
19+
20+
This release can publish:
21+
22+
- Title of article
23+
- Body of article
24+
- hashtag(s) if any
25+
2526
## Mastodon APIs
2627

28+
This plugin depends on [Mastodon.py](https://github.com/halcy/Mastodon.py).
29+
2730
In order to publish on Mastodon you need to enter in `publishconf.py` the following information:
2831

29-
TODO
3032
``` python
31-
MASTODON_CONSUMER_KEY = ''
32-
...
33+
MASTODON_BASE_URL = 'URL of your Mastodon instance. For example https://mastodon.social'
34+
MASTODON_USERNAME = 'Your username for Mastodon login'
35+
MASTODON_PASSWORD = 'You password for Mastodon login'
3336
```
37+
There is no need to register an app in your Mastodon profile because *Pelican-toot* will do it for you!
3438

35-
This plugin depends on [Mastodon.py](https://github.com/halcy/Mastodon.py).
39+
On every run *Pelican-toot* looks for a file called `pelicantoot_clientcred.secret` and - if it is not found - it gets in touch with Mastodon, creates an app called *PelicanToot* and writes API keys and other necessary information in this file.
40+
41+
If you cancel this file *Pelican-toot* will create another app (this could be done in case of problem despite the fact Mastodon advise this is NOT a good behaviour since app should be created only once).

0 commit comments

Comments
 (0)