Skip to content

Commit

Permalink
chore: udpated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mauricerenck committed May 14, 2024
1 parent 8ed8f97 commit 553d0b2
Showing 1 changed file with 33 additions and 44 deletions.
77 changes: 33 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Komments
#### A Kirby comment plugin
# Komments

#### A Kirby comments plugin

![GitHub release](https://img.shields.io/github/release/mauricerenck/komments.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)

Expand All @@ -11,56 +12,44 @@

Use one of these three methods to install the plugin:

- composer (recommended): `composer require mauricerenck/komments`
- zip file: unzip [master.zip](https://github.com/mauricerenck/komments/releases/latest) as folder `site/plugins/komments`
- composer (recommended): `composer require mauricerenck/komments`
- zip file: unzip [main.zip](https://github.com/mauricerenck/komments/releases/latest) as folder `site/plugins/komments`

### Setup
## Setup

* [How to configure the plugin](docs/options.md)
* [Setting up the panel](docs/panel.md)
* [Setting up your templates](docs/templates.md)
* [Receive Webmentions](docs/webmentions.md)
* [Get notifications for new comments](docs/notifications.md)
* [FAQ](docs/faq.md)
- [How to configure the plugin](docs/options.md)
- [Setting up the panel](docs/panel.md)
- [Setting up your templates](docs/templates.md)
- [Receive Webmentions](docs/webmentions.md)
- [Get notifications for new comments](docs/notifications.md)
- [FAQ](docs/faq.md)

---
## Features

- Receive comments from a form on your site
- The user will be informed that the comment is in moderation
- Spam detection
- auto delete spam or just mark comments as spam
- Receive webmentions (using an additional plugin)
- Panel support
- Dashboard for comments in moderation/spam
- Support for Kirby stats
- Moderate comments on the panel page
- Disable/enable comments per page
- Disable comments after a certain number of days in relation to the publish date
- Reply to comments
- Verified badge for logged in users
- Automatically publish comments of verified users
- Automatically publish comments of specified users
- E-Mail notifications for new comments (instant or via cronjob)


- Receive comments from a form on your site
- The user will be informed that the comment is in moderation
- Spam detection
- auto delete spam or just mark comments as spam
- Receive webmentions (using an additional plugin)
- Panel support
- Dashboard for comments in moderation/spam
- Support for Kirby stats
- Moderate comments on the panel page
- Disable/enable comments per page
- Disable comments after a certain number of days in relation to the publish date
- Reply to comments
- Verified badge for logged in users
- Automatically publish comments of verified users
- Automatically publish comments of specified users
- E-Mail notifications for new comments (instant or via cronjob)

---

## Roadmap
## Roadmap

- [x] Kirby 4 ready
- [x] New panel view for moderation
- [x] Mark comment as spam
- [x] Mark comment as verified
- [x] Delete comment
- [x] Pending comments field
- [x] Switch to KirbyUp
- [ ] Reply from within panel
- [ ] Comments list on page level
- [x] Move "send to mastodon" to IndieConnector
- [x] Move "ping archive.org" to IndieConnector
- [x] Move "send webmentions" to IndieConnector
- [ ] Mark webmentions from known users as verified
- [ ] Reply from within panel
- [ ] Comments list on panel page level
- [ ] Login via IndieAuth, Mastodon, GitHub
- [ ] Up- Down-Vote comments

Please use the [IndieConnector Plugin](https://github.com/mauricerenck/indieConnector) in addition to send webmentions

0 comments on commit 553d0b2

Please sign in to comment.