Skip to content

Commit 7accdae

Browse files
author
vagrant
committed
Changed README
1 parent 570aeef commit 7accdae

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

README.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,24 @@
1-
# League Skeleton
1+
# Diffbot PHP API Wrapper
22

3-
[![Latest Version](https://img.shields.io/github/release/thephpleague/skeleton.svg?style=flat-square)](https://github.com/thephpleague/skeleton/releases)
4-
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
5-
[![Build Status](https://img.shields.io/travis/thephpleague/skeleton/master.svg?style=flat-square)](https://travis-ci.org/thephpleague/skeleton)
6-
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton/code-structure)
7-
[![Quality Score](https://img.shields.io/scrutinizer/g/thephpleague/skeleton.svg?style=flat-square)](https://scrutinizer-ci.com/g/thephpleague/skeleton)
8-
[![Total Downloads](https://img.shields.io/packagist/dt/league/skeleton.svg?style=flat-square)](https://packagist.org/packages/league/skeleton)
9-
10-
**Note:** Replace `skeleton` with the correct package name in the above URLs, then delete this line.
11-
12-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
13-
PSRs you support to avoid any confusion with users and contributors.
3+
This package is a slightly overengineered Diffbot API wrapper. It uses Guzzle to make API calls. To learn more about Diffbot see [here](http://www.sitepoint.com/tag/diffbot/) and [their homepage](http://diffbot.com).
4+
Right now it only supports Analyze, Product, Image and Article APIs, but can also accommodate Custom APIs. Crawlbot, Search and Discussion API support coming soon.
145

156
## Install
167

178
Via Composer
189

1910
``` bash
20-
$ composer require league/skeleton
11+
composer require swader/diffbot-php-client
2112
```
2213

2314
## Usage
2415

25-
``` php
26-
$skeleton = new League\Skeleton();
27-
echo $skeleton->echoPhrase('Hello, League!');
28-
```
16+
Todo
2917

3018
## Testing
3119

3220
``` bash
33-
$ phpunit
21+
phpunit
3422
```
3523

3624
## Contributing
@@ -39,8 +27,7 @@ Please see [CONTRIBUTING](https://github.com/thephpleague/:package_name/blob/mas
3927

4028
## Credits
4129

42-
- [:author_name](https://github.com/:author_username)
43-
- [All Contributors](https://github.com/thephpleague/:package_name/contributors)
30+
- [Bruno Skvorc](https://github.com/swader)
4431

4532
## License
4633

0 commit comments

Comments
 (0)