Skip to content

Commit

Permalink
ReadMe updated
Browse files Browse the repository at this point in the history
  • Loading branch information
circuscode committed Apr 23, 2024
1 parent aba1fc9 commit e8f92b5
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
21 changes: 18 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Following toot objects are supported.

* Text
* Images
* Galleries
* URLs
* Hashtags
* Mentions
Expand All @@ -62,7 +63,6 @@ Following toot objects are supported.

Following toot objects are not supported.

* Galleries
* Audio
* Video
* Poll
Expand Down Expand Up @@ -131,6 +131,10 @@ TootPress does not modify the existing canonical url handling in WordPress. If y

The length of the cron period in combination with the configuration of caching determines how early a toot will be displayed within the blog. If a toot should be displayed as early as possible, the caching must be deactivated for the page containing the toots. Another possibility is removing the affected page from the cache, if new toots have been loaded. For this, a WordPress Action is fired by the plugin, which then must be processed by your caching plugin.

### How are backlinks to Mastodon displayed?

Backlinks to Mastodon can be activated in the plugin settings. In this case, the Mastodon Logo, which is shown for each toot, will be extended with an link to the original toot on the corresponding Mastodon instance. Recommendation is not activating the backlinks as this could cause an negative impact on SEO rating.

### Does TootPress support WordPress Multisite?

No. TootPress does not support the WordPress Multisite Feature. The plugin is working on the master-site, but is not working on all other child sites within the wordpress network.
Expand All @@ -139,8 +143,7 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo

* Low maturity level
* Early stage of development
* Future updates may require a complete reload of the toots.
* To avoid data inconsistancy and process errors
* Future updates may require a complete reload of the toots

## Branches

Expand Down Expand Up @@ -174,6 +177,18 @@ This project is licensed under the GPL3 License.

## Changelog

### 0.3 "Deadpool"

* April 2024
* Feature: Support of Gallery Toots
* Feature: Amount of Toots will be shown in WordPress Dashboard
* Feature: Option to activate Backlinks to Mastodon
* Changed: Label of User Interface Section in Plugin Options
* Bugfix: Plugin CSS will now really be activated
* Bugfix: Rewrite Rules will be updated after changed settings
* Bugfix: Internal Plugin Version will be set corretly
* Bugfix: CSS Option will be set correctly with Restore of default Settings

### 0.2.1

* April 2023
Expand Down
21 changes: 20 additions & 1 deletion readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Following toot objects are supported.

* Text
* Images
* Galleries
* URLs
* Hashtags
* Mentions
Expand All @@ -68,7 +69,6 @@ Following toot objects are supported.

Following toot objects are not supported.

* Galleries
* Audio
* Video
* Poll
Expand Down Expand Up @@ -132,12 +132,28 @@ TootPress does not modify the existing canonical url handling in WordPress. If y

The length of the cron period in combination with the configuration of caching determines how early a toot will be displayed within the blog. If a toot should be displayed as early as possible, the caching must be deactivated for the page containing the toots. Another possibility is removing the affected page from the cache, if new toots have been loaded. For this, a WordPress Action is fired by the plugin, which then must be processed by your caching plugin.

= How are backlinks to Mastodon displayed? =

Backlinks to Mastodon can be activated in the plugin settings. In this case, the Mastodon Logo, which is shown for each toot, will be extended with an link to the original toot on the corresponding Mastodon instance. Recommendation is not activating the backlinks as this could cause an negative impact on SEO rating.

= Does TootPress support WordPress Multisite? =

No. TootPress does not support the WordPress Multisite Feature. The plugin is working on the master-site, but is not working on all other child sites within the wordpress network.

== Changelog ==

= 0.3 "Deadpool" =

* April 2024
* Feature: Support of Gallery Toots
* Feature: Amount of Toots will be shown in WordPress Dashboard
* Feature: Option to activate Backlinks to Mastodon
* Changed: Label of User Interface Section in Plugin Options
* Bugfix: Plugin CSS will now really be activated
* Bugfix: Rewrite Rules will be updated after changed settings
* Bugfix: Internal Plugin Version will be set corretly
* Bugfix: CSS Option will be set correctly with Restore of default Settings

= 0.2.1 =

* April 2023
Expand All @@ -156,5 +172,8 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo

== Upgrade Notice ==

= 0.3 =
This version brings gallery support and contains major bugfixes.

= 0.2.1 =
This version includes bugfixing only.

0 comments on commit e8f92b5

Please sign in to comment.