Added readme, license
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal 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)
|
||||
Reference in New Issue
Block a user