Commit 88c9788

@@ -1,8 +1,19 @@
 # Minbox
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/minbox`. To experiment with that code, run `bin/console` for an interactive prompt.
+A minimal SMTP server written in ruby. `Minbox` offers a command line
+interface and is useful for end-to-end test suites or as a standalone SMTP server
+for development.
 
-TODO: Delete this and the text above, and describe your gem
+`Minbox` is capable of publishing email messages to `stdout`, the `file`
+system or to `redis`.
+
+The `file` system publisher will write all emails to `./tmp` of the
+directory where you run minbox from. Each file is named with the format
+of `<timestamp>.eml`.
+
+The `redis` publisher will publish all emails to a channel named
+`minbox`. Use the `REDIS_URL` environment variable to control the redis
+client configuration.  See [this](https://github.com/redis/redis-rb/blob/df07a4c90413ed5dda7bc8fe928b00aaad5462fa/lib/redis/client.rb#L9) for more information.
 
 ## Installation
 
@@ -22,7 +33,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```bash
+モ minbox
+minbox commands:
+  minbox client <HOST> <PORT>  # SMTP client
+  minbox help [COMMAND]        # Describe available commands or one specific command
+  minbox server <HOST> <PORT>  # SMTP server
+  minbox version               # Display the current version
+```
+
+To start an SMTP server run:
+
+```bash
+モ minbox server localhost 8080
+D, [2019-03-12T17:08:19.671765 #36618] DEBUG -- : Starting server on port 8080...
+D, [2019-03-12T17:08:19.679380 #36618] DEBUG -- : Server started!
+```
+
+You can use the `--output` option to configure the different types of
+publishers to publish to. The following example will publish emails to
+`stdout`, `file` system, and `redis`.
+
+```bash
+モ minbox server localhost 8080 --output=stdout file redis
+D, [2019-03-12T17:16:03.564426 #36907] DEBUG -- : Starting server on port 8080...
+D, [2019-03-12T17:16:03.565964 #36907] DEBUG -- : Server started!
+```
+
+To send an example email:
+
+```bash
+モ minbox client localhost 8080
+```
 
 ## Development
 
@@ -32,7 +74,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/minbox.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mokhan/minbox.
 
 ## License