From 3f09fbb56382d483654bc2f7f7ab3096dceb06cd Mon Sep 17 00:00:00 2001 From: Daniel Waxweiler Date: Thu, 9 Jun 2022 20:16:07 +0200 Subject: [PATCH] create installation section in readme.txt --- source/changelog.txt | 1 + source/readme.txt | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/source/changelog.txt b/source/changelog.txt index 3c5edf8..e593aba 100644 --- a/source/changelog.txt +++ b/source/changelog.txt @@ -4,6 +4,7 @@ - Show loading indicator during request #### Changed - 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 #### Removed #### Fixed diff --git a/source/readme.txt b/source/readme.txt index 43ebd4e..348a057 100644 --- a/source/readme.txt +++ b/source/readme.txt @@ -23,13 +23,15 @@ Features - Set the URL of the Mobilizon instance 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: `[-events-list events-count=3]` Optionally, you can only show the events of a specific group by indicatings its 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`. -The source code is available on [Github](https://github.com/dwaxweiler/connector-mobilizon). - ## Screenshots 1. Events list 2. General settings