Skip to content

Commit b09c935

Browse files
committed
Updates readme with additional documentation.
1 parent f984f98 commit b09c935

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1+
# Summarizer
2+
13
## Overview
24

3-
Summarizer provides an elegant interface to summarize text using a variety of third-party tools and services.
5+
Summarizer provides an elegant interface to summarize text using a variety of third-party providers.
46

57
**Supported Providers:**
68

79
* DayRev (local)
8-
* Smmry
10+
* [Smmry](https://github.com/dayrev/smmry-sdk-php)
911

10-
##Usage
12+
## Installation
13+
Run the following [composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) command to add the package to your project:
14+
15+
```
16+
composer require dayrev/summarizer
17+
```
1118

12-
$summarizer = DayRev\Summarizer\Provider::instance('smmry', ['api_key' => 'YOURKEYHERE']);
13-
$content = $summarizer->summarize($text);
19+
Alternatively, add `"dayrev/summarizer": "^1.0"` to your composer.json file.
20+
21+
##Usage
22+
```php
23+
$summarizer = DayRev\Summarizer\Provider::instance('smmry', ['api_key' => 'YOURKEYHERE']);
24+
$content = $summarizer->summarize($text);
25+
```
1426

1527
## Tests
16-
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:
28+
To run the test suite, run the following commands from the root directory:
1729

1830
```
1931
composer install
20-
vendor/bin/phpunit
32+
vendor/bin/phpunit -d smmry_api_key=YOUR_SMMRY_API_KEY
2133
```
34+
35+
> **Note:** A valid Smmry API key is required when running the integration tests.

0 commit comments

Comments
 (0)