Skip to content

Commit 12fd6a8

Browse files
committed
Restructured
1 parent 32a150f commit 12fd6a8

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

readme.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ TootPress copies your toots from Mastodon to WordPress continuously.
66

77
TootPress brings your data back and copies your toots from Mastodon to WordPress continuously. The toots will be saved in the WordPress database and can be displayed on the blog chronologically (but do not have to). Indeed, Mastodon is also blogging, micro-blogging so to speak.
88

9-
## Functions
9+
## Features
1010

1111
* Copy your toots back
1212
* Copy your tooted images back
@@ -30,7 +30,7 @@ TootPress brings your data back and copies your toots from Mastodon to WordPress
3030
4. Retrieve your Account ID (in WordPress under Tools/Toots)
3131
5. Maintain the Account ID in the TootPress Settings
3232
6. Create a new WordPress Page and add the Page to your Menu
33-
7. Maintain the Page ID in the TootPress Settings (you find the Page ID in URL of the Browser when editing the Page in WordPress)
33+
7. Maintain the Page ID in the TootPress Settings\(you find the Page ID in URL of the Browser when editing the Page in WordPress)
3434
8. Run Mastodon API Request once (in WordPress under Tools/Toots)
3535
9. Activate Steady Fetch
3636
10. That's it!
@@ -48,17 +48,6 @@ TootPress brings your data back and copies your toots from Mastodon to WordPress
4848
* There is no prescribed order for the execution of Steady Fetch, Complete Timeline or manual requests
4949
* If problems occur, TootPress provides a Healthy Check
5050

51-
## CSS classes
52-
53-
TootPress comes with basic CSS Styles. For best fit it is required to add additional styles in your theme. All TootPress UI elements can be addressed with individual CSS selectors. Please use the browser development tools to find the right classes.
54-
55-
## Data & Files
56-
57-
TootPress creates 2 folders within wp-content/uploads.
58-
59-
* tootpress-mastodonapidata = Archive of the received Mastodon API data
60-
* tootpress-images = Toot Image Folder
61-
6251
## Supported Toot Objects
6352

6453
Following toot objects are supported.
@@ -88,15 +77,26 @@ Following toot types are excluded from the data transfer.
8877
* Replys
8978
* Private Toots
9079

91-
## TootPress API
80+
## CSS classes
9281

93-
WordPress Action: tootpress_toots_update (fired on toot update)
82+
TootPress comes with basic CSS Styles. For best fit it is required to add additional styles in your theme. All TootPress UI elements can be addressed with individual CSS selectors. Please use the browser development tools to find the right classes.
83+
84+
## Data & Files
85+
86+
TootPress creates 2 folders within wp-content/uploads.
87+
88+
* tootpress-mastodonapidata = Archive of the received Mastodon API data
89+
* tootpress-images = Toot Image Folder
9490

9591
## TootPress Cron Jobs @ WordPress
9692

9793
* Steady Fetch (every 15 minutes, customizable)
9894
* Load Complete Timeline (every 5 minutes)
9995

96+
## TootPress API
97+
98+
WordPress Action: tootpress_toots_update (fired on toot update)
99+
100100
## WordPress Framework
101101

102102
Following components of WordPress are used in TootPress.
@@ -124,16 +124,12 @@ TootPress does not modify the existing canonical url handling in WordPress. If y
124124

125125
### What have to be considered with the usage of caching plugins?
126126

127-
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.
127+
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.
128128

129129
### Does TootPress support WordPress Multisite?
130130

131131
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.
132132

133-
## Live Demo
134-
135-
[Here!](https://www.unmus.de/troets/)
136-
137133
## Maturity Grade
138134

139135
* Low maturity level
@@ -152,6 +148,10 @@ This repository follows the git-flow workflow to a large extent.
152148

153149
Hotfix and release branches will not be applied.
154150

151+
## Live Demo
152+
153+
[Here!](https://www.unmus.de/troets/)
154+
155155
## Built With
156156

157157
* [Visual Studio Code](https://code.visualstudio.com)

0 commit comments

Comments
 (0)