add changelog file, add maintenance instructions, harmonize markdown style
This commit is contained in:
parent
cf5ce6eb76
commit
cd94a764bf
|
@ -9,11 +9,13 @@
|
||||||
|
|
||||||
### Development build
|
### Development build
|
||||||
1. Build: `npm run build-dev`
|
1. Build: `npm run build-dev`
|
||||||
|
2. Make sure to keep `changelog.txt` up-to-date.
|
||||||
|
|
||||||
### Release procedure
|
### Release procedure
|
||||||
1. Build: `npm run build-prod`
|
1. Make sure `changelog.txt` is up-to-date. Use a new version number and copy over the new section into `readme.txt`.
|
||||||
2. Determine minimum PHP version for code and update package.json if needed: `./vendor/bin/phpcompatinfo analyser:run ./source`
|
2. Build: `npm run build-prod`
|
||||||
3. Make sure screenshots are up-to-date.
|
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
|
### Other commands
|
||||||
- Run tests: `npm test`
|
- Run tests: `npm test`
|
||||||
|
|
|
@ -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
|
|
@ -1,4 +1,4 @@
|
||||||
=== <wordpress-nice-name> ===
|
# <wordpress-nice-name>
|
||||||
Contributors: dwaxweiler
|
Contributors: dwaxweiler
|
||||||
Tags: mobilizon, events
|
Tags: mobilizon, events
|
||||||
Stable tag: <wordpress-version>
|
Stable tag: <wordpress-version>
|
||||||
|
@ -9,7 +9,7 @@ License: <wordpress-license>
|
||||||
|
|
||||||
<wordpress-description>
|
<wordpress-description>
|
||||||
|
|
||||||
== Description ==
|
## Description
|
||||||
|
|
||||||
<wordpress-nice-name> allows you to display the upcoming events of [Mobilizon](https://joinmobilizon.org/), which is a federated event listing platform.
|
<wordpress-nice-name> 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: `[<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]`
|
||||||
|
|
||||||
== Screenshots ==
|
## Screenshots
|
||||||
1. Events list
|
1. Events list
|
||||||
2. General settings
|
2. General settings
|
||||||
3. Widget creation
|
3. Widget creation
|
||||||
4. Shortcut creation
|
4. Shortcut creation
|
||||||
|
|
||||||
== Changelog ==
|
## Changelog
|
||||||
|
|
||||||
= 0.1.0 =
|
### [0.1.0] - 2021-01-09
|
||||||
* initial release
|
initial release
|
||||||
|
|
Loading…
Reference in New Issue