summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Leland <rich@richleland.com>2016-03-07 11:31:48 -0500
committerRichard Leland <rich@richleland.com>2016-03-07 11:31:48 -0500
commite3f286a4d0ca70050136eee8482b6ab4c5032d3e (patch)
tree74ecb77acd83cd56963536f03d11c2cab27bd122
parent304703a64352ee065431238618b211f6c6bff821 (diff)
parent65ceba6cb9394474ea25cd550a7750f3a1569701 (diff)
downloadphp-sparkpost-e3f286a4d0ca70050136eee8482b6ab4c5032d3e.zip
php-sparkpost-e3f286a4d0ca70050136eee8482b6ab4c5032d3e.tar.gz
php-sparkpost-e3f286a4d0ca70050136eee8482b6ab4c5032d3e.tar.bz2
Merge pull request #49 from SparkPost/add-ivory-note
Adding Ivory note to README
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3759cd2..d68aa85 100644
--- a/README.md
+++ b/README.md
@@ -7,11 +7,11 @@
[![Travis CI](https://travis-ci.org/SparkPost/php-sparkpost.svg?branch=master)](https://travis-ci.org/SparkPost/php-sparkpost)
[![Coverage Status](https://coveralls.io/repos/SparkPost/php-sparkpost/badge.svg?branch=master&service=github)](https://coveralls.io/github/SparkPost/php-sparkpost?branch=master) [![Slack Status](http://slack.sparkpost.com/badge.svg)](http://slack.sparkpost.com)
-The official PHP binding for your favorite SparkPost APIs!
+The official PHP library for using [the SparkPost REST API](https://developers.sparkpost.com).
-Before using this library, you must have a valid API Key.
+**Note: We understand that the ivory-http-adapter we use in this library is deprecated in favor of httplug. We use Ivory internally to make it simple for you to use whatever HTTP library you want. The deprecation won't affect or limit our ongoing support of this PHP library.**
-To get an API Key, please log in to your SparkPost account and generate one in the Settings page.
+Before using this library, you must have a valid API Key. To get an API Key, please log in to your SparkPost account and generate one in the Settings page.
## Installation
The recommended way to install the SparkPost PHP Library is through composer.