diff --git a/README.rst b/README.md similarity index 60% rename from README.rst rename to README.md index fcb113f..0f8b56f 100644 --- a/README.rst +++ b/README.md @@ -1,14 +1,17 @@ -MailDump -======== +# Maildump [![Available on PyPI](https://img.shields.io/pypi/v/maildump.svg)](https://pypi.python.org/pypi/maildump/) -MailDump is a python-based clone of the awesome `MailCatcher`_ tool. Its -purpose is to provide developers a way to let applications send emails + + + + +MailDump is a python-based clone of the awesome [MailCatcher](https://github.com/sj26/mailcatcher/blob/master/README.md) tool. Its purpose is to provide developers a way to let applications send emails without actual emails being sent to anyone. Additionally lazy developers might prefer this over a real SMTP server simply for the sake of it being much easier and faster to set up. -Features --------- +## Features Since the goal of this project is to have the same features as MailCatcher I suggest you to read its readme instead. @@ -17,19 +20,17 @@ However, there is one unique feature in MailDump: Password protection for the web interface. If your MailDump instance is listening on a public IP you might not want your whole company to have access to it. Instead you can use an Apache-style htpasswd file. I have tested it with SHA-encrypted -passwords but you can use any encryption supported by `passlib.apache`_. +passwords but you can use any encryption supported by [passlib.apache](http://pythonhosted.org/passlib/lib/passlib.apache.html). -Usage ------ +## Usage -After installing maildump, run ``maildump --help`` for a list of available +After installing maildump, run `maildump --help` for a list of available command line arguments. By default maildump runs its webserver on port 1080 and its SMTP server on port 1025 (both only available via localhost). Unless you specify a database file, received mails are lost when maildump terminates. -Credits -------- +## Credits The layout of the web interface has been taken from MailCatcher. No Copy&Paste involved - I rewrote the SASS/Compass stylesheet from @@ -39,15 +40,9 @@ looks as good or even better feel free to send a pull request. I'd actually prefer a layout that differs from MailCatcher at least a little bit but I'm somewhat bad at creating layouts! -The icon was created by `Tobia Crivellari`_. +The icon was created by [Tobia Crivellari](http://dribbble.com/TobiaCrivellari) -License -------- +## License Copyright © 2013-2020 Adrian Mönnich (adrian@planetcoding.net). Released -under the MIT License, see `LICENSE`_ for details. - -.. _MailCatcher: https://github.com/sj26/mailcatcher/blob/master/README.md -.. _passlib.apache: http://pythonhosted.org/passlib/lib/passlib.apache.html -.. _Tobia Crivellari: http://dribbble.com/TobiaCrivellari -.. _LICENSE: https://github.com/ThiefMaster/maildump/blob/master/LICENSE +under the MIT License, see [LICENSE](https://github.com/ThiefMaster/maildump/blob/master/LICENSE) for details. diff --git a/setup.cfg b/setup.cfg index 1c40a7d..0888800 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,8 @@ name = maildump version = 1.0 license = MIT description = An SMTP server that makes all received mails accessible via a web interface and REST API. -long_description = file: README.rst +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/ThiefMaster/maildump download_url = https://github.com/ThiefMaster/maildump author = Adrian Mönnich