Skip to content

Commit 337bb80

Browse files
committed
chore: k5 note
1 parent 25767cb commit 337bb80

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,60 @@
11
# Kirby IndieConnector
2+
23
#### Send and receive Webmentions, send Mastodon and Bluesky posts or act like an ActivityPub instance
34

45
![GitHub release](https://img.shields.io/github/release/mauricerenck/indieConnector.svg?maxAge=1800) ![License](https://img.shields.io/github/license/mashape/apistatus.svg) ![Kirby Version](https://img.shields.io/badge/Kirby-4%2B-black.svg)
56

67
---
8+
79
IndieConnector is your interface to the IndieWeb. It'll help you to:
810

9-
- Receive Webmentions
10-
- Send Webmentions
11-
- Post to Mastodon
12-
- Post to Bluesky
13-
- Act like a ActivityPub Instance
11+
- Receive Webmentions
12+
- Send Webmentions
13+
- Post to Mastodon
14+
- Post to Bluesky
15+
- Act like a ActivityPub Instance
1416

1517
This plugins handles all the stuff around Webmentions and then normalizes the format and triggers a hook. Other plugins can then subscribe to this hook and use the data.
1618

1719
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).
1820

1921
---
22+
2023
## Installation
2124

2225
Use one of these three methods to install the plugin:
2326

24-
- `composer require mauricerenck/indieConnector`
25-
- unzip [main.zip](https://github.com/mauricerenck/indieConnector/releases/latest) to `site/plugins/indieConnector`
27+
- `composer require mauricerenck/indieConnector`
28+
- unzip [main.zip](https://github.com/mauricerenck/indieConnector/releases/latest) to `site/plugins/indieConnector`
2629

2730
---
2831

2932
## Docs
3033

31-
* [Receiving Webmentions](docs/receiving.md)
32-
* [Sending Webmentions](docs/sending.md)
33-
* [Activate the Panel view](docs/panel-view.md)
34-
* [Post to Mastodon or Bluesky](docs/mastodon.md)
35-
* [Reply via Mastodon](docs/mastodon-replies.md)
36-
* [Be a Mastodon Instance](docs/activitypub.md) (ActivityPub)
37-
* [Subscribe to the hook](docs/hook.md)
38-
* [Using webmention.io](docs/webmentionio.md)
39-
* [Using microformats](docs/microformats.md)
40-
* [All options](docs/options.md)
34+
- [Receiving Webmentions](docs/receiving.md)
35+
- [Sending Webmentions](docs/sending.md)
36+
- [Activate the Panel view](docs/panel-view.md)
37+
- [Post to Mastodon or Bluesky](docs/mastodon.md)
38+
- [Reply via Mastodon](docs/mastodon-replies.md)
39+
- [Be a Mastodon Instance](docs/activitypub.md) (ActivityPub)
40+
- [Subscribe to the hook](docs/hook.md)
41+
- [Using webmention.io](docs/webmentionio.md)
42+
- [Using microformats](docs/microformats.md)
43+
- [All options](docs/options.md)
4144

4245
---
4346

4447
## Roadmap
4548

46-
- [x] Manual queue cleanup
47-
- [ ] Queue for sending webmentions
48-
- [ ] Queue for sending mastodon posts
49-
- [ ] Queue for sending bluesky posts
50-
- [ ] Nested indieweb replies
51-
- [ ] Blocklist for users on Mastodon and Bluesky
52-
- [ ] Manual post to Mastodon and Bluesky
53-
- [ ] Block hosts from within the panel
54-
- [ ] Post complete texts to Mastodon and Bluesky splitted in threads
55-
- [ ] Option for using Kirby UUID permalinks in Mastodon/Bluesky posts
56-
- [ ] Get replies from Mastodon and Bluesky without brid.gy
49+
- [x] Kirby 5 ready
50+
- [x] Manual queue cleanup
51+
- [ ] Queue for sending webmentions
52+
- [ ] Queue for sending mastodon posts
53+
- [ ] Queue for sending bluesky posts
54+
- [ ] Nested indieweb replies
55+
- [ ] Blocklist for users on Mastodon and Bluesky
56+
- [ ] Manual post to Mastodon and Bluesky
57+
- [ ] Block hosts from within the panel
58+
- [ ] Post complete texts to Mastodon and Bluesky splitted in threads
59+
- [ ] Option for using Kirby UUID permalinks in Mastodon/Bluesky posts
60+
- [ ] Get replies from Mastodon and Bluesky without brid.gy

0 commit comments

Comments
 (0)