Skip to content

Commit

Permalink
Adding readme instructios
Browse files Browse the repository at this point in the history
  • Loading branch information
bissolli committed Aug 13, 2018
1 parent e7ad541 commit c251f39
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,30 @@
[![Total Downloads](https://poser.pugx.org/bissolli/twitter-php-scraper/downloads)](https://packagist.org/packages/bissolli/twitter-php-scraper)
[![License](https://poser.pugx.org/bissolli/twitter-php-scraper/license)](https://packagist.org/packages/bissolli/twitter-php-scraper)

Twitter PHP Scrapper. Get account information, tweets, likes, re-tweets and comments.
Twitter PHP Scrapper. Get account information, tweets, likes, re-tweets and comments through the Twitter handle.

## Code Example
To get the user profile:
```php
$twitter = new \Bissolli\TwitterScraper\Twitter('official_php');
var_dump($twitter->getProfile());
```
To load all the reachable tweets (last 20 tweets)
```php
$twitter = new \Bissolli\TwitterScraper\Twitter('official_php')->loadTweets();
var_dump($twitter->getProfile());
var_dump($twitter->getTweets());
```

## Installation

### Using composer
```sh
composer require bissolli/twitter-php-scraper
```

### If you don't have composer
You can download it [here](https://getcomposer.org/download/).

# TODO
* [ ] Implement .travis.yml

0 comments on commit c251f39

Please sign in to comment.