Skip to content

Commit

Permalink
Feature/send webmentions (#5)
Browse files Browse the repository at this point in the history
* feat: send webmentions
* feat: send toots

* improvement: phpunit setup
* improvement: new plugin update reminder
* improvement: added composer release script
* improvement: setup endpoint

* fix: web hook endpoint case insensitive now
  • Loading branch information
mauricerenck committed Feb 26, 2022
1 parent e0a8198 commit 68afd7f
Show file tree
Hide file tree
Showing 66 changed files with 6,970 additions and 355 deletions.
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@

This plugin currently works only with webmention.io and is a replacement for the old "Tratschtante" plugin.

**Be aware:**
IndieConnector receives and sends Webmentions. But it doesn't "do" anything with received Webmentions. It's function is to handle all the stuff around Webmentions and then normalize the format and trigger a hook. Other plugins can then subscribe to this hook and use the data.

The panel view of this plugin only works with the upcomming Kirby 3.6 release! Beside that, receiving Webmentions with older Kirby version will work.

IndieConnector receives (and soon sends) Webmentions. But it doesn't "do" anything with it. It's function is to handle all the stuff around Webmentions and then normalize the format and trigger a hook. Other plugins can then subscribe to this hook and use the data.

If you want Webmentions to be shown on your pages, you have to use additional plugins (or write your own) which use IndieConnector to handle Webmentions. For example the [Komments plugin]() which will then show received webmentions as a comment (or in any other way you wish).
If you want Webmentions to be shown on your pages, you have to use additional plugins (or write your own) which use IndieConnector to handle Webmentions. For example the [Komments plugin](https://github.com/mauricerenck/komments) which will then show received webmentions as a comment (or in any other way you wish).

---
## Installation
Expand All @@ -24,25 +20,32 @@ Use one of these three methods to install the plugin:
- unzip [master.zip](https://github.com/mauricerenck/indieConnector/releases/latest) to `site/plugins/indieConnector`
- `git submodule add https://github.com/mauricerenck/indieConnector.git site/plugins/indieConnector`

* [Switch from Tratschtante to IndieConnector](docs/switch.md)
* [Setup the plugin](docs/setup.md)
* [Subscribe to the hook](docs/hook.md)
---

## Docs

* [Receiving Webmentions](docs/receiving.md)
* [Sending Webmentions](docs/sending.md)
* [Post to Mastodon](docs/mastodon.md)
* [Subscribe to the hook](docs/hook.md)
* [All options](docs/options.md)
* [Switch from Tratschtante to IndieConnector](docs/switch.md)
---

## Features

- Receive Webmentions on your site
- Send Webmentions from your site
- Shows a Webmention overview in the panel
- Propagates Webmentions via Hook so other plugins can subscribe and use them
- Send updates to mastodon (toot)

---

## Roadmap

- [x] Kirby 3.6 ready
- [x] View Webmention stats in the panel
- [ ] Send webmentions
- [ ] Notify on Mastodon
- [ ] Ping Archive.org
- [x] Send webmentions
- [x] Notify on Mastodon
- [ ] Implement Webmentions without webmention.io
15 changes: 11 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "Kirby Webmentions your plugins can subscribe to",
"type": "kirby-plugin",
"license": "MIT",
"homepage": "https://github.com/mauricerenck/indieConnector",
"authors": [
{
"name": "Maurice Renck",
Expand All @@ -20,11 +21,12 @@
},
"require": {
"getkirby/composer-installer": "^1.1",
"php": ">=7.3.0"
"php": ">=7.3.0",
"indieweb/mention-client": "^1.2"
},
"require-dev": {
"getkirby/cms": "^3.6",
"phpunit/phpunit": "9.5"
"phpunit/phpunit": "^9.5"
},
"replace": {
"mauricerenck/tratschtante": "*"
Expand All @@ -38,6 +40,11 @@
"scripts": {
"test": "vendor/bin/phpunit --testdox tests",
"build-test-package": "git archive HEAD -o indieConnector.zip --worktree-attributes",
"build-composer": "composer install --no-dev --optimize-autoloader"
"build-composer": "composer install --no-dev --optimize-autoloader",
"build-release": [
"composer test",
"composer install --no-dev --optimize-autoloader",
"npm run build"
]
}
}
}
Loading

0 comments on commit 68afd7f

Please sign in to comment.