Updated ROADMAP and README

README.md

@@ -1,16 +1,36 @@
 # mlmmj-light-web-ecg
 
 ## NOTE
-This repository was forked from [GitHub](https://github.com/sergei-bondarenko/mlmmj-light-web) and is adapted to the needs of the ECG movement. All changes to the projects will be tracked in this repository.
+This repository was forked from [GitHub](https://github.com/sergei-bondarenko/mlmmj-light-web) and is adapted to the needs of the ECG movement. All changes to the project will be tracked in this repository.
 
 ## Description
 
-A light PHP web interface for [mlmmj](http://mlmmj.org/). It does **not** use a database. Available in English only.
+A light PHP web interface for managing [mlmmj](http://mlmmj.org/) mailing lists. It does not use a database and is available in English.
 
 
+## Features
+
+### For users
+- Authentication via LDAP
+- List all available mailinglists on the server
+- Only show the edit function for mailing lists where the user is set as owner
+
+### For admins
+- Error handling regarding invalid user input
+- Strip leading and trailing blanks for subscribers and moderators list
+- Audit log of changes
+- Notify admins about errors via Rocket:Chat bot implementation
+
 ## Installation
 
-Change the values in `init.php`
+Clone the git repository to your webserver:
+```bash
+https://git.ecogood.org/services/mlmmj-light-web-ecg.git
+```
+
+Enter your ECG account credentials and the tool gets downloaded.
+
+Change the values in `init.php` and you are ready to go:
 
 | Variable | Description | Default value |
 | --- | --- | --- |
@@ -19,11 +39,14 @@ Change the values in `init.php`
 | `$web_url` | URL to the webinterface with leading https:// | `https://list.ecogood.org/`
 | `$language` | As the original tool had two languages this is not relevant anymore. Currently the tool supports English only | `en` |
 | `$domain_global` | Name of the folder within `$lists_path` where all mailing lists are stored | `mlmmj` |
-| `$rc_webhook` | The Rocket:Chat webhook string to be able to send notifications regarding errors | |
+| `$rc_webhook` | The Rocket:Chat webhook string to be able to send notifications regarding errors | Something like `ohciu8ni2aiBohciu/aikek3eikeche1eech8cumae3hiewuJ1ooqu0reik8feeGho` |
 | `$current_version` | No need to change this | depends on the current version |
 | `$headline` | No need to change this | `Manage your ECG mailing lists " . $current_version` |
 | `$debug` | Turns the debug mode on which prints error messages on the screen | `false` |
 
+
+### Restore original templates
+
 If you want to restore the original templates:
 1. Navigate to directory `misc`
 2. Untar the following two archives:
@@ -33,3 +56,25 @@ tar xzvf ./templates.tar.gz -C .
 tar xzvf ./smarty.tar.gz -C .
 ```
 
+## Update
+
+Enter the directory where the files are located.
+
+```bash
+cd mlmmj-light-web-ecg
+git pull
+```
+
+Check if the values from `init.php` are still valid or need to be adapted.
+
+## Changelog
+
+v1.0 - Initial release (08/13/2021)
+
+## Roadmap
+
+see [ROADMAP.md](ROADMAP.md)
+
+## Wishes / Bugs / Contributions
+
+If you have any feature wish or you found a bug just [file an issue](https://git.ecogood.org/services/mlmmj-light-web-ecg/issues) in this git repository. Any contribution to this repository is highly appreciated. Don't forget to increase the version number then.

ROADMAP.md

@@ -1,4 +1,4 @@
-## list.ecogood.org
+# ROADMAP
 
 - [x] in Git einchecken und Änderungen vornehmen
 - [x] ggf. Anpassung des Domainnamens auf mlmmj (wenn nötig)
@@ -8,8 +8,16 @@
 - [ ] Login über LDAP
 - [ ] Nach Klick auf Liste Berechtigung prüfen über list-owner
 - [ ] Audit-Log aller Änderungen
+Updated at: 08/13/2021
 
----
+## Feature wishes
+- [ ] Automatically put square brackets around the prefix `[prefix]`
+- [ ] Count number of subscribers and moderators in the text areas
+- [ ] Allow admins to edit all mailing lists
+- [ ] Check for duplicates in the subscriber / moderator text area
+- [ ] Allow users to subscribe to a list by clicking a button
+- [ ] Show the list-description
+- [ ] Someone enters his email address into an input field and gets an email with all mailing lists he is subscribed to
 
 ## Besprechung mit Nino 23.07
 - [ ] Voreinstellen der [] für den Listen-Prefix
@@ -34,3 +42,4 @@
 - [ ] User können sich selbst an die Listen subscriben
 - [ ] list-description anzeigen
 - [ ] Person gibt ihre Mailadresse ein und bekommt dann per Mail eine Liste all ihrer Subscriptions zurück
+If you have any feature wish just [file an issue](https://git.ecogood.org/services/mlmmj-light-web-ecg/issues) in this git repository.