Skip to content

Commit 97512f3

Browse files
committed
Enhances readme with title and installation instructions.
1 parent 518c442 commit 97512f3

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1+
# Extractor
2+
13
## Overview
24

3-
Extractor provides an elegant interface to extract content from a URL using a variety of third-party tools and services.
5+
Extractor provides an elegant interface to extract content from a URL using a variety of third-party providers.
46

5-
**Supported Providers:**
7+
**Supported Providers**
68

79
* Embedly
810
* Goose
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/extractor
17+
```
18+
19+
Alternatively, add `"dayrev/extractor": "^1.0"` to your composer.json file.
1120

12-
$extractor = DayRev\Extractor\Provider::instance('embedly', array('api_key' => 'YOURKEYHERE'));
13-
$content = $extractor->extract($this->url);
21+
##Usage
22+
```php
23+
$extractor = DayRev\Extractor\Provider::instance('embedly', ['api_key' => 'YOURKEYHERE']);
24+
$content = $extractor->extract($this->url);
25+
```
1426

1527
## Tests
1628
To run the test suite, run the following commands from the root directory:

0 commit comments

Comments
 (0)