create installation section in readme.txt

This commit is contained in:
Daniel Waxweiler 2022-06-09 20:16:07 +02:00
parent 3360a9e7a7
commit 3f09fbb563
2 changed files with 5 additions and 2 deletions

View File

@ -4,6 +4,7 @@
- Show loading indicator during request - Show loading indicator during request
#### Changed #### Changed
- Set list style type to none and left padding to zero for all occurences - Set list style type to none and left padding to zero for all occurences
- Move shortcut usage description into installation section in `readme.txt`
#### Deprecated #### Deprecated
#### Removed #### Removed
#### Fixed #### Fixed

View File

@ -23,13 +23,15 @@ Features
- Set the URL of the Mobilizon instance in the settings - Set the URL of the Mobilizon instance in the settings
- Toggle adding named offset in brackets after the time in the settings - Toggle adding named offset in brackets after the time in the settings
The source code is available on [Github](https://github.com/dwaxweiler/connector-mobilizon).
## Installation
Shortcut format with limiting the number of events to show to 3 for example: `[<wordpress-name>-events-list events-count=3]` Shortcut format with limiting the number of events to show to 3 for example: `[<wordpress-name>-events-list events-count=3]`
Optionally, you can only show the events of a specific group by indicatings its name: `[<wordpress-name>-events-list events-count=3 group-name="mygroup"]` Optionally, you can only show the events of a specific group by indicatings its name: `[<wordpress-name>-events-list events-count=3 group-name="mygroup"]`
You have to use their username, e.g. `@nosliensvivants`, and append the name of their instance if they use a different one, e.g. `@yaam_berlin@mobilize.berlin`. You have to use their username, e.g. `@nosliensvivants`, and append the name of their instance if they use a different one, e.g. `@yaam_berlin@mobilize.berlin`.
The source code is available on [Github](https://github.com/dwaxweiler/connector-mobilizon).
## Screenshots ## Screenshots
1. Events list 1. Events list
2. General settings 2. General settings