Added readme, license

This commit is contained in:
2023-04-16 18:46:18 +02:00
parent 6045e2d1a3
commit 700eb88061
4 changed files with 81 additions and 0 deletions

29
README.md Normal file
View File

@@ -0,0 +1,29 @@
# DDNS
_malias_ is a helper for mailcow instances. You can create, delete, search and list aliases.
## Installation
Download the latest relase from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). You can also rename the file ```malias.py``` to just ```malias``` and make the file executable with ```chmod +x malias```. To install required python modules run ```pip3 install -r requirements.txt```
## Usage
For instructions run
```bash
malias -h
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
## Support
If you found a bug or you have suggestion for new features create an issue.
## License
[<img src="https://gitlab.pm/rune/ddns/src/branch/main/mit.png">](https://gitlab.pm/rune/ddns/src/branch/main/LICENSE.md)