ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-27 16:24:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix #29 - add more descriptive overview to readme

Browse source
This commit is contained in:
Ian Kent 2015-02-24 23:06:00 +00:00
parent da1b7ec64a
commit 861f70329d
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -10,6 +10,14 @@ Inspired by [MailCatcher](http://mailcatcher.me/), easier to install.
Built with Go - MailHog runs without installation on multiple platforms.
### Overview
MailHog is an email testing tool for developers:
* Configure your application to use MailHog for SMTP delivery
* View messages in the web UI, or retrieve them with the JSON API
* Optionally release messages to real SMTP servers for delivery
### Getting started
1. Either:
@ -32,7 +40,7 @@ Built with Go - MailHog runs without installation on multiple platforms.
* Chaos Monkey for failure testing
* See [Introduction to Jim](/docs/JIM.md) for more information
* HTTP API to list, retrieve and delete messages
* See [APIv1 documentation](/docs/APIv1.md) for more information
* See [APIv1](/docs/APIv1.md) and [APIv2](/docs/APIv2.md) documentation for more information
* Multipart MIME support
* Download individual MIME parts
* In-memory message storage