Skip to content

Commit f41fa74

Browse files
committed
Changes wording SDK to Library and adds some spacing so the file renders better in MacDown
1 parent 25ad599 commit f41fa74

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Sign up](https://app.sparkpost.com/sign-up?src=Dev-Website&sfdcid=70160000000pqBb) for a SparkPost account and visit our [Developer Hub](https://developers.sparkpost.com) for even more content.
44

5-
# SparkPost PHP SDK
5+
# SparkPost PHP Library
66

77
[![Travis CI](https://travis-ci.org/SparkPost/php-sparkpost.svg?branch=master)](https://travis-ci.org/SparkPost/php-sparkpost)
88
[![Coverage Status](https://coveralls.io/repos/SparkPost/php-sparkpost/badge.svg?branch=master&service=github)](https://coveralls.io/github/SparkPost/php-sparkpost?branch=master)
@@ -14,22 +14,28 @@ Before using this library, you must have a valid API Key.
1414
To get an API Key, please log in to your SparkPost account and generate one in the Settings page.
1515

1616
## Installation
17-
The recommended way to install the SparkPost PHP SDK is through composer.
17+
The recommended way to install the SparkPost PHP Library is through composer.
18+
1819
```
1920
# Install Composer
2021
curl -sS https://getcomposer.org/installer | php
2122
```
22-
Next, run the Composer command to install the SparkPost PHP SDK:
23+
24+
Next, run the Composer command to install the SparkPost PHP Library:
25+
2326
```
2427
composer require sparkpost/php-sparkpost
2528
```
29+
2630
After installing, you need to require Composer's autoloader:
31+
2732
```php
2833
require 'vendor/autoload.php';
2934
use SparkPost\SparkPost;
3035
```
3136

3237
## Setting up a Request Adapter
38+
3339
Because of dependency collision, we have opted to use a request adapter rather than
3440
requiring a request library. This means that your application will need to pass in
3541
a request adapter to the constructor of the SparkPost Library. We use the [Ivory HTTP Adapter] (https://github.com/egeloen/ivory-http-adapter) in SparkPost. Please visit their repo
@@ -38,6 +44,7 @@ need to require one and create an adapter from it and pass it along. The exampl
3844
GuzzleHttp Client Library.
3945

4046
An Adapter can be setup like so:
47+
4148
```php
4249
use SparkPost\SparkPost;
4350
use GuzzleHttp\Client;
@@ -48,6 +55,7 @@ $sparky = new SparkPost($httpAdapter, ['key'=>'YOUR API KEY']);
4855
```
4956

5057
## Getting Started: Your First Mailing
58+
5159
```php
5260
require 'vendor/autoload.php';
5361

@@ -114,10 +122,10 @@ try {
114122
## Tips and Tricks
115123
### General
116124
* You _must_ provide at least an API key when instantiating the SparkPost Library - `[ 'key'=>'184ac5480cfdd2bb2859e4476d2e5b1d2bad079bf' ]`
117-
* The SDK's features are namespaced under the various SparkPost API names.
125+
* The Libraries features are namespaced under the various SparkPost API names.
118126

119127
### Transmissions
120-
* If you specify a stored recipient list and inline recipients in a Transmission, you will recieve an error.
128+
* If you specify a stored recipient list and inline recipients in a Transmission, you will receive an error.
121129
* If you specify HTML and/or Plain Text content and then provide RFC-822 encoded content, you will receive an error.
122130
* RFC-822 content is not valid with any other content type.
123131
* If you specify a stored template and also provide inline content via `html` or `text`, you will receive an error.

0 commit comments

Comments
 (0)