1
0
mirror of https://codeberg.org/linos/mobilizon-block.git synced 2024-12-21 23:44:04 +01:00

enhance readme

This commit is contained in:
André Menrath 2021-08-04 19:42:43 +02:00
parent bf3c6ba613
commit c0419614bb

View File

@ -1,6 +1,5 @@
# Mobilizon-Block (Wordpress Plugin)
This Plugin is beta-state. Use it carefully! But you are welcome to report bugs or feature wishes.
This Wordpress-Plugin is inspired by https://github.com/wordpress-connector-for-mobilizon/connector-mobilizon/.
## Features
- Easy to use and setup
@ -8,14 +7,15 @@ This Wordpress-Plugin is inspired by https://github.com/wordpress-connector-for-
- Show events of specific group or whole instance
- Configuration in the block settings:
- Maximum number of events shown
- Different styles using presets (soon)
- How many detail are displayed
- Selectable designs (soon)
- Amount of event-details displayed (soon)
- Events get cached on the server as transients (soon)
## Differences to connector-mobilizon
This Wordpress-Plugin is inspired by https://github.com/wordpress-connector-for-mobilizon/connector-mobilizon/.
- Using a Gutenberg-Block, not a shortcode
- Fetches the events on the server side (php), not on the client side (JavaSkript), which is out-of-the-box GDPR-compatible.
- Fetches the events on the server side (php), not on the client side (JavaScript), which is out-of-the-box GDPR-compatible.
## Changelog
### v0.3 - 04. August 2021
@ -34,7 +34,7 @@ This Wordpress-Plugin is inspired by https://github.com/wordpress-connector-for-
# Contribute
## Development
- If you want to contribute code, translations or have ideas so on, please see the (https://codeberg.org/linos/mobilizon-block/issues)[issue] section first. You are very welcome.
If you want to contribute code, translations or have ideas and so on, please see the [https://codeberg.org/linos/mobilizon-block/issues](issue) section first. You are very welcome.
### 👉 `npm install`
- Fetches the dependencies