readme-en.md aktualisiert

readme-en.md

@@ -0,0 +1,35 @@
+# MastodonAPI
+
+A plugin to import **public Toots** from Mastodon into your Yellow blog.  
+⚠️ Only **public** posts will be imported.
+
+## Installation
+
+1. Download the ZIP file  
+2. Copy it into the `/system/extensions` directory  
+3. Reload your website – the plugin is now installed
+
+## Usage
+
+The plugin is triggered via a **custom webhook**.  
+When the webhook is called, it fetches your Toots from the Mastodon API and creates blog posts from them.  
+Optionally, you can specify a **#hashtag** to import only matching posts.
+
+## Settings
+
+All settings are in `system/extensions/yellow-system.ini`:
+
+- **MastodonapiInstanceUrl** – your Mastodon instance URL (e.g. `https://mastodon.social`)  
+- **MastodonapiAccountId** – your Mastodon user ID (numeric, e.g. `1234567890`)  
+- **MastodonapiHashtag** – leave empty to import all public posts; set to `#hashtag` to import only matching posts  
+- **MastodonapiAuthor** – author name to use for imported blog posts  
+- **MastodonapiTag** – tag to assign to imported blog posts  
+- **MastodonapiFolder** – path to your blog folder (e.g. `content/1-blog/`)  
+- **MastodonapiTriggerPath** – webhook path, e.g. `/mastodonapi-webhook-CHANGE_THIS_SECRET_KEY`  
+  *(Be sure to change it! Anyone with this link can trigger the plugin.)*
+
+💡 You can also call the webhook via a cron job to run the plugin automatically (e.g., every hour).
+
+## Developer
+
+Simon Pipe