Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Publish the configuration so that its not overwritten during a composer update.
  • Loading branch information
spinegar committed Aug 29, 2013
1 parent 272d7d9 commit 7c01266
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Furthermore, add the following the the `aliases` array:
'Mailchimp' => 'Hugofirth\Mailchimp\Facades\Mailchimp',
),

Publish the configuration

$ php artisan config:publish hugofirth/mailchimp

Lastly, run the command `composer update`.

Expand All @@ -43,7 +47,7 @@ _\* The subsequent steps should be repeated for any file `app.php` created for a

###Usage:

Your unique MailChimp API key should be set in the package's config found in `..vendor/hugofirth/mailchimp/src/config/config.php`
Your unique MailChimp API key should be set in the package's config found in `app/config/packages/hugofirth/mailchimp/config.php`

Methods of the MailChimp api class work as described by the MailChimp API docs found [Here][3]. Thanks to Laravel's use of the "Facade" design pattern, all methods may be called in the following manner:

Expand All @@ -58,4 +62,4 @@ Enjoy!

[1]: http://apidocs.mailchimp.com/api/downloads/#php
[2]: http://laravel.com/
[3]: http://apidocs.mailchimp.com/api/1.3/
[3]: http://apidocs.mailchimp.com/api/1.3/

0 comments on commit 7c01266

Please sign in to comment.