From: Maurizio Paglia <mpaglia0@gmail.com>
Date: Wed, 16 Nov 2022 13:46:25 +0000 (+0100)
Subject: Update README.md
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=e2075485d9f61f56288553d094750a4f64834b0d;p=blog.git

Update README.md
---

diff --git a/README.md b/README.md
index 3800ca9e..ca2dcf74 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,33 @@ A Pelican plugin to publish content on Mastodon
 
 ## THIS IS A VERY EARLY STAGE OF DEVELOPMENT 
 ## DO NOT USE!!
+
+====================================================================================
+TEST - TEST - TEST
+====================================================================================
+
+Hacked from [Pelican-tweet](https://github.com/mpaglia0/Pelican-tweet).
+
+Needs Python > 3.0
+
+## How it works
+
+*Pelican-toot* will search your contents for articles (actually ALL contents except pages) that are not in a `draft` status.
+
+On its first run it creates a file called `posted_on_Mastodon.txt` in your Pelican root directory.
+
+Then it tries to post all eligible articles to Mastodon and - if post routine returns no errors - writes article URL in `posted_on_Mastodon.txt`.
+
+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`).
+
+## Mastodon APIs
+
+In order to publish on Mastodon you need to enter in `publishconf.py` the following information:
+
+TODO
+``` python
+MASTODON_CONSUMER_KEY = ''
+...
+```
+
+This plugin depends on [Mastodon.py](https://github.com/halcy/Mastodon.py).