enhance readme
This commit is contained in:
parent
bf3c6ba613
commit
c0419614bb
10
readme.md
10
readme.md
|
@ -1,6 +1,5 @@
|
||||||
# Mobilizon-Block (Wordpress Plugin)
|
# Mobilizon-Block (Wordpress Plugin)
|
||||||
This Plugin is beta-state. Use it carefully! But you are welcome to report bugs or feature wishes.
|
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
|
## Features
|
||||||
- Easy to use and setup
|
- 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
|
- Show events of specific group or whole instance
|
||||||
- Configuration in the block settings:
|
- Configuration in the block settings:
|
||||||
- Maximum number of events shown
|
- Maximum number of events shown
|
||||||
- Different styles using presets (soon)
|
- Selectable designs (soon)
|
||||||
- How many detail are displayed
|
- Amount of event-details displayed (soon)
|
||||||
- Events get cached on the server as transients (soon)
|
- Events get cached on the server as transients (soon)
|
||||||
|
|
||||||
|
|
||||||
## Differences to connector-mobilizon
|
## 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
|
- 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
|
## Changelog
|
||||||
### v0.3 - 04. August 2021
|
### v0.3 - 04. August 2021
|
||||||
|
@ -34,7 +34,7 @@ This Wordpress-Plugin is inspired by https://github.com/wordpress-connector-for-
|
||||||
# Contribute
|
# Contribute
|
||||||
|
|
||||||
## Development
|
## 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`
|
### 👉 `npm install`
|
||||||
- Fetches the dependencies
|
- Fetches the dependencies
|
||||||
|
|
Loading…
Reference in New Issue