StephanRichter/Widerhall
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Activity

added doc

Browse Source
This commit is contained in:
Stephan Richter
2022-04-22 20:17:47 +02:00
parent 0db87fac1e
commit d3c27d063e
3 changed files with 123 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md Normal file
View File

@@ -0,0 +1,37 @@
# Welcome to Widerhall!
## What is Widerhall?
_Widerhall_ is the german word for reverberation.
This is a software dedicated to the creation of mailing lists without knowhow regarding _mailservers_.
All you need to create a mailing list with _Widerhall_ is this software and an IMAP-enabled email address.
## How does it work?
After you started the software, you go to it's front page, set up an admin account.
Then, as admin, you can create mailing lists by just entering the respective login credentials into this software.
When enabling a list, this software connects to the respective mailbox and waits for incoming messages. Everytime a message is received, the software forwards it to any subscriber of that list.
## How does subscription work?
You can make public every mailing list you create.
All public mailing lists are presented on _Widerhall_`s front page. Visitors may join each of the public mailing lists by hitting the _subscribe_ button. The need to enter their name and email address. After that, they receive a confirmation email with a link, that completes their subscription.
## Is it free?
Yes. _Widerhall_ is FOSS, which stands for Free Open Source Software.
That means every on can obtain a free copy of the source code and use it on it`s own behalf.
## Instructions
Refer to [Instructions] for hints on setup and maintenance.
## Current state
This software is brand new and may contain bugs. Regard it as alpha state, do not use in production environments!
[Instructions]: doc/instructions.md