Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

replaced readme

  • Loading branch information...
commit 3ff287c11be6493b1185dedc418b4bbbcfc3bb1f 1 parent 983f43f
Adam Jackett authored
Showing with 31 additions and 30 deletions.
  1. +1 −0  .gitignore
  2. +0 −30 README
  3. +30 −0 readme.md
View
1  .gitignore
@@ -0,0 +1 @@
+*.sublime-*
View
30 README
@@ -1,30 +0,0 @@
-Grab the latest package from the Downloads page and upload to /path/to/modx/core/packages
-
-Once uploaded, login to the Manager and go to System > Package Management.
-From the Download Extras dropdown, choose Search Locally for Packages. Install the package when it finds it (you'll need your MailChimp API key) and that's it!
-
-Now just call the snippet wherever you want the form to show, for example:
- [[!mailchimp? listId=`1342f13bd0`]]
-
-You can also get the basic snippet code from the MailChimp page in the Manager. You'll find it in the Components menu.
-
-
-With the exception of listId, all snippet paremeters are optional. If you use subscribeTpl you decide how much control you get. Use the
-
-apiKey Specify this to override the API Key set in the system settings.
-mergeTags Specify which fields to display in a comma-separated list. Defaults to "EMAIL".
- If you don't include the email tag, it will be added automatically.
-
-subscribeTpl The chunk ID to use for the form output. Placeholders listed below.
- [placeholders] => [
- fields: The generated merge field HTML
- ]
-rowTpl Which chunk to use for each form input row.
- [placeholders] => [
- tag: The field's tag
- name: The merge field's name
- input: The actual form element
- ]
-
-successId ID of a resource to redirect to on success. Defaults to current page
-failureId ID of a resource to redirect to on failure. Defaults to current page
View
30 readme.md
@@ -0,0 +1,30 @@
+== modMailchimp ==
+
+modMailchimp is a MODx package that lets you easily place a subscribe form anywhere on your website for any list you want.
+
+=== Installation ===
+
+Grab the latest package from the Downloads page and upload to /path/to/modx/core/packages
+
+Once uploaded, login to the Manager and go to System > Package Management.
+From the Download Extras dropdown, choose Search Locally for Packages. Install the package when it finds it (you'll need your MailChimp API key) and that's it!
+
+=== Basic Usage ===
+
+The basic snippet call only needs a listId:
+{{{
+[[!modMailchimp?listId=`3363a41ae0`]]
+}}}
+The easiest way to get a subscribe form up and running on your site is to go on the modMailchimp custom manager page (you'll find it in the Components menu). Find the list you want to use and copy the snippet code. Now all you have to do is paste it wherever you want the form to display.
+
+To generate a form that will unsubscribe an email address, just add the unsubscribe action:
+{{{
+[[!modMailchimp?listId=`3363a41ae0` &action=`unsubscribe`]]
+}}}
+
+=== Advanced Usage ===
+
+The modMailchimp snippet is very flexible. If you want to dive straight in, have a look at the [[Snippet Parameters]], otherwise check out some of the examples below:
+
+=== Changelog ===
+Look in /core/components/modmailchimp/docs/changelog.txt
Please sign in to comment.
Something went wrong with that request. Please try again.