-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Rich Leland
committed
Mar 24, 2016
1 parent
a2c821c
commit 2c1883a
Showing
2 changed files
with
4 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,12 +29,10 @@ From Test Email section, try sending a test email to yourself to make sure the c | |
|
||
## Development | ||
* Install WordPress | ||
* Clone this repository | ||
* Create a symlink to the repository's `trunk` directory in WordPress plugins directory. | ||
|
||
For example, if you've cloned this repository to `~/src/wordpress-sparkpost` and your WordPress is installed in `~/src/wordpress`, you should create a symlink like following | ||
* Clone this repository to the WordPress plugins directory: | ||
|
||
``` | ||
ln -s ~/src/wordpress-sparkpost ~/src/wordpress/wp-content/plugins/wordpress-sparkpost | ||
git clone [email protected]:SparkPost/wordpress-sparkpost.git ~/src/wordpress/wp-content/plugins/wordpress-sparkpost | ||
``` | ||
|
||
* Activate the plugin from admin panel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,30 +33,6 @@ Option 2: Install manually: | |
|
||
Upon successful activation, **SparkPost** will appear on the _Settings_ menu in the Wordpress Admin Panel. Click on _Settings -> SparkPost_ to open the SparkPost plugin configuration page and complete setup. | ||
|
||
Fill in each plugin configuration field: | ||
|
||
* Check the "Send email using SparkPost" box to enable the plugin | ||
|
||
* **Method**: select whether to send using the HTTP API or SMTP | ||
|
||
* **API Key**: a SparkPost API key with *Send via SMTP* and *Transmission Read/Write* permissions | ||
* Hint: they look like this: 39fb780c182927cde6baddab00f67676feed1beef17 | ||
|
||
* **Enable tracking**: select whether to enable open and click tracking | ||
|
||
* **Template**: SparkPost template to use when sending email | ||
* Note: a template can only be used if the HTTP API method is selected | ||
|
||
* **From name**: a human-friendly name to show in 'From' headers | ||
* e.g. your name or your site's name | ||
|
||
* **From email**: your 'From' email address | ||
* e.g. [email protected] | ||
|
||
For information on how to create an API key, follow the [official documentation](https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys). | ||
|
||
Ensure your [sending domain](https://app.sparkpost.com/configuration/sending-domains) is properly configured within SparkPost. | ||
|
||
== Frequently Asked Questions == | ||
|
||
= What do I need to start using this plugin? = | ||
|
@@ -98,7 +74,7 @@ Visit our [support site](https://support.sparkpost.com/) for help. | |
- Update copy | ||
|
||
= 1.1.3 = | ||
Richer plugin settings error messages and help text, TLS now permanently enabled | ||
- Richer plugin settings error messages and help text, TLS now permanently enabled | ||
|
||
= 1.1.2 = | ||
- Shortened the plugin name to just SparkPost, added more readme copy, renamed 'SMTP password' setting to 'API key' | ||
|