README.md in mailkick-0.4.1 vs README.md in mailkick-0.4.2
- old
+ new
@@ -87,64 +87,78 @@
```ruby
Mailkick.fetch_opt_outs
```
-#### Sendgrid
+The following services are supported:
-Add the gem
+- [Mailchimp](#mailchimp)
+- [Mailgun](#mailgun)
+- [Mandrill](#mandrill)
+- [Postmark](#postmark)
+- [SendGrid](#sendgrid)
-```ruby
-gem 'sendgrid_toolkit'
-```
+Will gladly accept pull requests for others.
-Be sure `ENV["SENDGRID_USERNAME"]` and `ENV["SENDGRID_PASSWORD"]` are set.
+#### Mailchimp
-#### Mandrill
+Add the gem
```ruby
-gem 'mandrill-api'
+gem 'gibbon', '>= 2'
```
-Be sure `ENV["MANDRILL_APIKEY"]` is set.
+And set `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]`.
-#### Mailchimp
+#### Mailgun
+Add the gem
+
```ruby
-gem 'gibbon', '>= 2'
+gem 'mailgun-ruby'
```
-Be sure `ENV["MAILCHIMP_API_KEY"]` and `ENV["MAILCHIMP_LIST_ID"]` are set.
+And set `ENV["MAILGUN_API_KEY"]`.
-#### Mailgun
+#### Mandrill
+Add the gem
+
```ruby
-gem 'mailgun-ruby'
+gem 'mandrill-api'
```
-Be sure `ENV["MAILGUN_API_KEY"]` is set.
+And set `ENV["MANDRILL_APIKEY"]`.
#### Postmark
+Add the gem
+
```ruby
gem 'postmark'
```
-Be sure `ENV["POSTMARK_API_KEY"]` is set.
+And set `ENV["POSTMARK_API_KEY"]`.
-#### Other
+#### SendGrid
-Will gladly accept pull requests.
+Add the gem
+```ruby
+gem 'sendgrid-ruby'
+```
+
+And set `ENV["SENDGRID_API_KEY"]`. The API key requires only the `Suppressions` permission.
+
### Advanced
For more control over services, set them by hand.
```ruby
Mailkick.services = [
- Mailkick::Service::Sendgrid.new(api_key: "API_KEY"),
- Mailkick::Service::Mandrill.new(api_key: "API_KEY")
+ Mailkick::Service::SendGridV2.new(api_key: "API_KEY"),
+ Mailkick::Service::Mailchimp.new(api_key: "API_KEY", list_id: "LIST_ID")
]
```
## Multiple Lists
@@ -227,5 +241,14 @@
- [Report bugs](https://github.com/ankane/mailkick/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/mailkick/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/mailkick.git
+cd mailkick
+bundle install
+bundle exec rake test
+```