From 08b5653e1f3423c83c057669232b1bdbaa48673c Mon Sep 17 00:00:00 2001
From: miya0001 <miya@wpist.me>
Date: Sun, 9 Aug 2015 07:37:52 +0900
Subject: [PATCH] update readme

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

diff --git a/README.md b/README.md
index e69de29..5139243 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,76 @@
+# vccw/mailcatcher
+
+[![Build Status](https://travis-ci.org/megumi-wp-composer/wp-disable-upgrade-notice.svg?branch=master)](https://travis-ci.org/vccw-team/mailcatcher) [![Latest Stable Version](https://poser.pugx.org/vccw/mailcatcher/v/stable.svg)](https://packagist.org/packages/vccw/mailcatcher) [![Total Downloads](https://poser.pugx.org/vccw/mailcatcher/downloads.svg)](https://packagist.org/packages/vccw/mailcatcher) [![Latest Unstable Version](https://poser.pugx.org/vccw/mailcatcher/v/unstable.svg)](https://packagist.org/packages/vccw/mailcatcher) [![License](https://poser.pugx.org/vccw/mailcatcher/license.svg)](https://packagist.org/packages/vccw/mailcatcher)
+
+Re-routes all WordPress emails to Mailcatcher.
+
+http://mailcatcher.me/
+
+
+## How to use
+
+### Place a plugin into mu-plugins
+
+Place a plugins into mu-plugins like following.
+
+```
+<?php
+/*
+Plugin Name: mu-plugin for example.com
+*/
+
+require_once dirname( __FILE__ ) . '/vendor/autoload.php';
+```
+
+That's it!
+
+
+### Create a composer.json
+
+Create and place a composer.json into `muplugins/`.
+
+```
+{
+    "name": "mu-plugins",
+    "authors": [
+        {
+            "name": "John Smith",
+            "email": "john@example.com"
+        }
+    ],
+    "require": {
+        "vccw/mailcatcher": "*"
+    }
+}
+```
+
+### Install libraries
+
+Then run a `composer` command.
+
+```
+$ composer install
+```
+
+## How to update libraries
+
+```
+$ composer update
+```
+
+
+## How to development
+
+```
+$ git clone git@github.com:vccw-team/mailcatcher.git
+$ cd mailcatche
+$ composer install
+```
+
+### Running a PHPUnit
+
+After you run a `composer install`, then run `phpunit`.
+
+```
+$ phpunit
+```