Skip to content

Commit 2c1883a

Browse files
author
Rich Leland
committed
Address review feedback
1 parent a2c821c commit 2c1883a

File tree

2 files changed

+4
-30
lines changed

2 files changed

+4
-30
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,10 @@ From Test Email section, try sending a test email to yourself to make sure the c
2929

3030
## Development
3131
* Install WordPress
32-
* Clone this repository
33-
* Create a symlink to the repository's `trunk` directory in WordPress plugins directory.
34-
35-
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
32+
* Clone this repository to the WordPress plugins directory:
3633

3734
```
38-
ln -s ~/src/wordpress-sparkpost ~/src/wordpress/wp-content/plugins/wordpress-sparkpost
35+
git clone git@github.com:SparkPost/wordpress-sparkpost.git ~/src/wordpress/wp-content/plugins/wordpress-sparkpost
3936
```
37+
4038
* Activate the plugin from admin panel

readme.txt

+1-25
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,6 @@ Option 2: Install manually:
3333

3434
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.
3535

36-
Fill in each plugin configuration field:
37-
38-
* Check the "Send email using SparkPost" box to enable the plugin
39-
40-
* **Method**: select whether to send using the HTTP API or SMTP
41-
42-
* **API Key**: a SparkPost API key with *Send via SMTP* and *Transmission Read/Write* permissions
43-
* Hint: they look like this: 39fb780c182927cde6baddab00f67676feed1beef17
44-
45-
* **Enable tracking**: select whether to enable open and click tracking
46-
47-
* **Template**: SparkPost template to use when sending email
48-
* Note: a template can only be used if the HTTP API method is selected
49-
50-
* **From name**: a human-friendly name to show in 'From' headers
51-
* e.g. your name or your site's name
52-
53-
* **From email**: your 'From' email address
54-
* e.g. yourname@yourdomain.com
55-
56-
For information on how to create an API key, follow the [official documentation](https://support.sparkpost.com/customer/portal/articles/1933377-create-api-keys).
57-
58-
Ensure your [sending domain](https://app.sparkpost.com/configuration/sending-domains) is properly configured within SparkPost.
59-
6036
== Frequently Asked Questions ==
6137

6238
= What do I need to start using this plugin? =
@@ -98,7 +74,7 @@ Visit our [support site](https://support.sparkpost.com/) for help.
9874
- Update copy
9975

10076
= 1.1.3 =
101-
Richer plugin settings error messages and help text, TLS now permanently enabled
77+
- Richer plugin settings error messages and help text, TLS now permanently enabled
10278

10379
= 1.1.2 =
10480
- Shortened the plugin name to just SparkPost, added more readme copy, renamed 'SMTP password' setting to 'API key'

0 commit comments

Comments
 (0)