Skip to content

Commit c5fad4f

Browse files
committed
Adds installation instructions.
1 parent 8964bcf commit c5fad4f

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22

33
A simple SDK interface for interacting with the [Smmry](http://smmry.com) text summarization API.
44

5-
##Usage
5+
## Installation
6+
Run the following [composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) command to add the package to your project:
7+
8+
```
9+
composer require dayrev/smmry-sdk-php
10+
```
611

7-
$sdk = new DayRev\Smmry\SDK(array('api_key' => 'YOURKEYHERE', 'summary_length' => 5));
8-
$summary = $sdk->summarizeUrl('http://collegefootball.ap.org/article/mayfield-leads-oklahoma-35-19-sugar-bowl-win-over-auburn');
12+
Alternatively, add `"dayrev/smmry-sdk-php": "^1.0"` to your composer.json file.
13+
14+
##Usage
15+
```php
16+
$sdk = new DayRev\Smmry\SDK(array('api_key' => 'YOURKEYHERE', 'summary_length' => 5));
17+
$summary = $sdk->summarizeUrl('http://collegefootball.ap.org/article/mayfield-leads-oklahoma-35-19-sugar-bowl-win-over-auburn');
18+
```
919

1020
## Tests
11-
To run the test suite, install [composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) and then run the following commands from the root directory:
21+
To run the test suite, run the following commands from the root directory:
1222

1323
```
1424
composer install

0 commit comments

Comments
 (0)