-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |