Skip to content

Commit 1199a0c

Browse files
authored
Merge pull request #15 from circuscode/develop
Update readme
2 parents 1cc27fa + 2fe2542 commit 1199a0c

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

readme.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ TootPress brings your data back and copies your toots from Mastodon to WordPress
2020
2. Rename the downloaded folder to "tootpress"
2121
2. Upload the folder to the WordPress Plugin Directory
2222
3. Activate the plugin in WordPress
23-
4. Follow the configuration manual
23+
4. Follow the configuration steps below
2424

2525
## Configuration
2626

@@ -77,13 +77,17 @@ Following toot types are excluded from the data transfer.
7777
* Replys
7878
* Private Toots
7979

80+
## Architecture
81+
82+
Data storage and process logic is separated from the WordPress Framework. The toots are not saved in the table wp_posts. And TootPress is not registering a custom post type for the toots as well.
83+
8084
## CSS classes
8185

8286
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.
8387

8488
## Data & Files
8589

86-
TootPress creates 2 folders within wp-content/uploads.
90+
TootPress creates 2 folders within the WordPress Uploads Directory.
8791

8892
* tootpress-mastodonapidata = Archive of the received Mastodon API data
8993
* tootpress-images = Toot Image Folder
@@ -147,7 +151,7 @@ This repository follows the git-flow workflow to a large extent.
147151
* feature branches contain dedicated features in development
148152
* bugfix branches contain dedicated bugfixes in development
149153

150-
Hotfix and release branches will not be applied.
154+
Hotfix and release branches will not be applied in most cases.
151155

152156
## Live Demo
153157

@@ -163,6 +167,10 @@ Hotfix and release branches will not be applied.
163167

164168
This project is licensed under the GPL3 License.
165169

170+
## Related Links
171+
172+
* [TootPress @ WordPress Plugin Directory](https://wordpress.org/plugins/tootpress/)
173+
166174
## Changelog
167175

168176
### 0.2 "Kate Bishop"
@@ -176,4 +184,4 @@ This project is licensed under the GPL3 License.
176184
### 0.1 "Ms. Marvel"
177185

178186
* March 2023
179-
* Initial Release
187+
* Initial Release

readme.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ Following toot types are excluded from the data transfer.
8383
* Replys
8484
* Private Toots
8585

86+
= Architecture =
87+
88+
Data storage and process logic is separated from the WordPress Framework. The toots are not saved in the table wp_posts. And TootPress is not registering a custom post type for the toots as well.
89+
8690
= CSS classes =
8791

8892
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.
@@ -94,7 +98,7 @@ TootPress creates 2 folders within the WordPress Uploads Directory.
9498
* tootpress-mastodonapidata = Archive of the received Mastodon API data
9599
* tootpress-images = Toot Image Folder
96100

97-
= Cron Jobs =
101+
= wpCrons =
98102

99103
* Steady Fetch (every 15 minutes, customizable)
100104
* Load Complete Timeline (every 5 minutes)

0 commit comments

Comments
 (0)