Skip to content

Commit

Permalink
README has more detailed install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
kochb committed Aug 15, 2013
1 parent 4785172 commit 1a76fde
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
@@ -1,13 +1,24 @@
CakePHP Mailgun Plugin
======================

Provides utilities for interacting with Mailgun in CakePHP.
This package provides two Mailgun transports - one implemented using CakePHP's HttpRequest utility and the other using curl.

Installation
------------
If you haven't already, sign up for a [Mailgun](http://www.mailgun.com/) account.

Install this package as a [CakePHP Plugin](http://book.cakephp.org/2.0/en/plugins.html).

git clone https://github.com/kochb/cakephp-mailgun.git app/Plugin/Mailgun
# If you prefer, use a submodule
git submodule add https://github.com/kochb/cakephp-mailgun.git app/Plugin/Mailgun

Load the plugin in your bootstrap.php.

CakePlugin::load('Mailgun');

Usage
-----
This package currently provides two Mailgun transports - one implemented using
CakePHP's HttpRequest utility and the other using curl.

To enable the transport, add the following information to your Config/email.php:

class EmailConfig {
Expand All @@ -18,3 +29,7 @@ To enable the transport, add the following information to your Config/email.php:
);
}


Use the [CakeEmail class](http://book.cakephp.org/2.0/en/core-utility-libraries/email.html) as normal, invoking the new configuration settings.

$email = new CakeEmail('mailgun');

0 comments on commit 1a76fde

Please sign in to comment.