From 981df6f16b50a4120a82b80365877e91547e4c28 Mon Sep 17 00:00:00 2001 From: Maurizio Paglia Date: Wed, 20 Dec 2023 10:08:19 +0100 Subject: [PATCH] Update README.md Repalced old 'pelican toot' refs with 'Fediverse' --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index fbe7a03e..3f4365a0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pelican-fediverse +# Fediverse A Pelican plugin to publish content on the Fediverse @@ -10,15 +10,15 @@ Hacked from [Pelican-tweet](https://github.com/mpaglia0/Pelican-tweet). ## How it works (Mastodon) -*pelican-fediverse* will search your contents for articles (actually ALL contents except pages) that are not in a `draft` status. +*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. -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`. +Then it tries to post all eligible articles to Mastodon and - if post routine returns no errors - writes posted article URLs 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`). -*pelican-fediverse* is at its very first stage of development, but it is already usable in product environments. +*Fediverse* is at its very first stage of development, but it is already usable in product environments. This release can publish: @@ -30,11 +30,11 @@ 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-fediverse* will trim `article.summary` accordingly. +If the total length of the post exceeds MAX length allowed from Mastodon, then *Fediverse* will trim `article.summary` accordingly. Hashtag(s) are taken - if any - from `article.tags` and concatenated separating each of them with commas. -Pelican can handle tags with whitespaces (for example `#My nice article`) without problems but hashtags in Mastodon are all written without. For this reason all whitespaces from Pelican hashtags will be removed before publishing (`#Mynicearticle`). +Pelican can nicely handle tags with whitespaces (for example `#My nice article`) but in Mastodon they must be written without. For this reason all whitespaces from Pelican hashtags will be removed before publishing (`#Mynicearticle`). ## Mastodon APIs @@ -47,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-fediverse* will do it for you! +There is no need to register an app in your Mastodon profile because *Fediverse* will do it for you! -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. +On every run *Fediverse* looks for a file called `pelicanfediverse_clientcred.secret` and - if it is not found - it gets in touch with Mastodon, creates an app called *PelicanFediverse* and writes API keys and other necessary information in this file. -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). +If you **cancel** this file *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