diff --git a/README.md b/README.md index 29c5ed9..889936f 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,13 @@ ### Development build 1. Build: `npm run build-dev` +2. Make sure to keep `changelog.txt` up-to-date. ### Release procedure -1. Build: `npm run build-prod` -2. Determine minimum PHP version for code and update package.json if needed: `./vendor/bin/phpcompatinfo analyser:run ./source` -3. Make sure screenshots are up-to-date. +1. Make sure `changelog.txt` is up-to-date. Use a new version number and copy over the new section into `readme.txt`. +2. Build: `npm run build-prod` +3. Determine minimum PHP version for code and update package.json if needed: `./vendor/bin/phpcompatinfo analyser:run ./source` +4. Make sure screenshots are up-to-date. ### Other commands - Run tests: `npm test` diff --git a/source/connector-mobilizon/changelog.txt b/source/connector-mobilizon/changelog.txt new file mode 100644 index 0000000..bf62614 --- /dev/null +++ b/source/connector-mobilizon/changelog.txt @@ -0,0 +1,13 @@ +### [Unreleased] +Added +- Add `changelog.txt` +- Add changelog maintenance steps to `README.md` +Changed +- Use same Markdown style in `README.md` as in other documents +Deprecated +Removed +Fixed +Security + +### [0.1.0] - 2021-01-09 +initial release diff --git a/source/connector-mobilizon/readme.txt b/source/connector-mobilizon/readme.txt index aa5b497..a8867f6 100644 --- a/source/connector-mobilizon/readme.txt +++ b/source/connector-mobilizon/readme.txt @@ -1,4 +1,4 @@ -=== === +# Contributors: dwaxweiler Tags: mobilizon, events Stable tag: @@ -9,7 +9,7 @@ License: -== Description == +## Description allows you to display the upcoming events of [Mobilizon](https://joinmobilizon.org/), which is a federated event listing platform. @@ -17,13 +17,13 @@ You can display the upcoming events using a widget and everywhere else using a s Shortcut format with limiting the number of events to show to 3 for example: `[-events-list events-count=3]` -== Screenshots == +## Screenshots 1. Events list 2. General settings 3. Widget creation 4. Shortcut creation -== Changelog == +## Changelog -= 0.1.0 = -* initial release +### [0.1.0] - 2021-01-09 +initial release