From 8adf49f5627456bac3829c24e3621421c9fff051 Mon Sep 17 00:00:00 2001 From: Maurizio Paglia Date: Tue, 1 Aug 2023 17:11:52 +0200 Subject: [PATCH] Update README.md Changed plugin name from Pelican-toot into pelican-fediverse --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7469fabc..671e1c36 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -# Pelican-toot +# pelican-fediverse -A Pelican plugin to publish content on Mastodon +A Pelican plugin to publish content on the Fediverse + +!warning! Under development. Presently only Mastodon is supported. DEVELOPERS NEEDED! Hacked from [Pelican-tweet](https://github.com/mpaglia0/Pelican-tweet). :warning: Needs Python > 3.0 -## How it works +## How it works (Mastodon) -*Pelican-toot* will search your contents for articles (actually ALL contents except pages) that are not in a `draft` status. +*pelican-fediverse* 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 populated with all your article URLs. @@ -16,7 +18,7 @@ Then it tries to post all eligible articles to Mastodon and - if post routine re 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`). -*Pelican-toot* is at its very first stage of development, but it is already usable in product environments. +*pelican-fediverse* is at its very first stage of development, but it is already usable in product environments. This release can publish: @@ -28,7 +30,7 @@ Title is taken from `article.title` Body is taken from `article.summary` with standard Pelican configuartion i.e. length trimmed to 50 words and summary ends with `...` OR with parameters you set in `pelicanconf.py` (`SUMMARY_MAX_LENGTH` and `SUMMARY_END_SUFFIX`). -If the total length of the post exceeds MAX length allowed from Mastodon, then *Pelican-toot* will trim `article.summary` accordingly. +If the total length of the post exceeds MAX length allowed from Mastodon, then *pelican-fediverse* will trim `article.summary` accordingly. Hashtag(s) are taken - if any - from `article.tags` and concatenated separating each of them with commas. @@ -45,8 +47,8 @@ MASTODON_BASE_URL = 'URL of your Mastodon instance. For example https://mastodon MASTODON_USERNAME = 'Your username for Mastodon login' MASTODON_PASSWORD = 'You password for Mastodon login' ``` -There is no need to register an app in your Mastodon profile because *Pelican-toot* will do it for you! +There is no need to register an app in your Mastodon profile because *pelican-fediverse* will do it for you! -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. +On every run *pelican-fediverse* 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. -If you **cancel** this file *Pelican-toot* will create another app on its next run (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). +If you **cancel** this file *pelican-fediverse* will create another app on its next run (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). -- 2.30.2