Permalink
Browse files

readme improvements

  • Loading branch information...
1 parent 437b474 commit 776634ce20a4184c8ad906e9e0eb5a5a626b1c64 @kennethreitz committed Apr 28, 2012
Showing with 6 additions and 5 deletions.
  1. +6 −5 README.rst
View
@@ -1,24 +1,26 @@
Inbox.py: SMTP Server for Humans
================================
-This project strives to be the simplest SMTP application possible.
+This is simplest SMTP server you'll ever see.
+
+And it's extremely fast. One instance easily handles 1000 emails/second.
Usage
-----
-Handle incoming emails::
+Give your app an inbox easily::
from inbox import Inbox
inbox = Inbox()
@inbox.collate
- def handle(to, from, body)
+ def handle(to, sender, body)
...
# Bind directly.
- inbox.serve(port=4467)
+ inbox.serve(address='0.0.0.0', port=4467)
# Argument parser.
# inbox.dispatch()
@@ -27,6 +29,5 @@ Handle incoming emails::
Powered By
----------
-- Ginkgo
- Gevent
- Good Intentions

0 comments on commit 776634c

Please sign in to comment.