README.md in workarea-mail_chimp-3.0.3 vs README.md in workarea-mail_chimp-3.0.4
- old
+ new
@@ -1,25 +1,41 @@
Workarea Mail Chimp
================================================================================
MailChimp plugin for the Worakrea e-commerce platform
-This plugin creates a basic integration between the WebLinc platform and
+This plugin creates a basic integration between the Workarea platform and
MailChimp's v3 API
It requires a mailchimp access token which can be generated by following
MailChimp's OAuth2 Flow here: <http://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/>
Scope and Dependencies
--------------------------------------------------------------------------------
-This plugin currently wraps functionality for subscribing and unsubscribing users
-by email, as well as retrieving interest groups (or categories) for users and lists
+This plugin currently wraps functionality for subscribing and unsubscribing users by email, as well as retrieving interest groups (or categories) for users and lists
-It is dependant on the [gibbon rubygem](https://github.com/amro/gibbon) which
-provides a basic wrapper for the MailChimp v3 API.
+It is dependant on the [gibbon rubygem](https://github.com/amro/gibbon) which provides a basic wrapper for the MailChimp v3 API.
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-mailchimp'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
Configuration
--------------------------------------------------------------------------------
This plugin requires gateway configuration in order to function.
@@ -63,53 +79,16 @@
* A user that was unsubscribed with the following email: `test-unsubscribed@weblinc.com`
* A subscribed user with the following email: `mdalton-simonpearce@weblinc.com`
-The specs use VCR cassettes to record http requests, so maintainers will need to
- flush the cassettes when modifying the requests.
+The specs use VCR cassettes to record http requests, so maintainers will need to flush the cassettes when modifying the requests.
-Getting Started
+Workarea Commerce Documentation
--------------------------------------------------------------------------------
-This gem contains a rails engine that must be mounted onto a host Rails application.
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
-You must have access to a WebLinc gems server to use this gem. Add your gems
-server credentials to Bundler:
-
- bundle config gems.weblinc.com my_username:my_password
-
-Or set the appropriate environment variable in a shell startup file:
-
- export BUNDLE_GEMS__WEBLINC__COM='my_username:my_password'
-
-Then add the gem to your application's Gemfile specifying the source:
-
- # ...
- gem 'workarea-mail_chimp', source: 'https://gems.weblinc.com'
- # ...
-
-Or use a source block:
-
- # ...
- source 'https://gems.weblinc.com' do
- gem 'workarea-mail_chimp'
- end
- # ...
-
-Update your application's bundle.
-
- cd path/to/application
- bundle
-
-WebLinc Platform Documentation
+License
--------------------------------------------------------------------------------
-See [http://developer.weblinc.com](http://developer.weblinc.com) for Workarea
-platform documentation.
-
-Copyright & Licensing
---------------------------------------------------------------------------------
-
-Copyright WebLinc 2015. All rights reserved.
-
-For licensing, contact sales@weblinc.com.
+Workarea Mailchimp is released under the [Business Software License](LICENSE)