From f5b7aca71285321f9457c88c21a55342dc2cff87 Mon Sep 17 00:00:00 2001 From: James Hillyerd Date: Thu, 11 Oct 2012 15:23:51 -0700 Subject: [PATCH] Add some text to readme and the MIT license. --- LICENSE | 20 ++++++++++++++++++++ README.md | 29 +++++++++++++++++++++++++++-- 2 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..01d5c17 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2012 James Hillyerd, All Rights Reserved + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 347b7a1..6121ba6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ -inbucket +Inbucket ======== -Simple SMTP server with web interface \ No newline at end of file +Inbucket is an email testing service; it will accept messages for any email +address and make them available to view via a web interface. + +It allows web developers, software engineers and system administrators to +quickly see the emailed output of ther applications. No per-account setup is +required! Mailboxes are created on the fly as mail is received for them, and +no password is required to browse the cotent of the mailboxes. + +Inbucket has a built-in SMTP server and stores incoming mail as flat files on +disk - no external SMTP or database daemons required. + +Status +------ +Inbucket is currently in development. It mostly works, but is not well +tested or documented. + +About +----- +Inbucket is written in [Google Go][1], and utilizes the [Revel framework][2] +for its web interface. + +Inbucket is open source software released under the MIT License. The latest +version can be found at [github](https://github.com/jhillyerd/inbucket). + +[1]: http://golang.org/ +[2]: http://robfig.github.com/revel/