Skip to content

Commit

Permalink
Merge pull request #4 from marcosgdf/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
rgomezcasas committed Jan 30, 2015
2 parents f3ed309 + 17269ff commit 40ff066
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,23 @@ composer require dotzecker/tuiter
```

## 2. Usage
The api is very simple and intuitive:

First, download you Twitter archive by clicking "Request your archive" in https://twitter.com/settings/account.

The API is very simple and intuitive:
```php
use Tuiter\Tuiter;

// Let's load our archive
$tweets = Tuiter::fromArchive(__DIR__ . '/your/awesome/path/to/tweets.csv');
```

Now you are able to manager your tweets in a fluent way, for example:
Now you are able to manage your tweets in a fluent way, for example:
```php
$unwantedTweets = $tweets->retweets()->before('2014-05-20')->get();
```

This is the list of filters avaliables:
This is the list of available filters:
* `->retweets($are = true)`
* `->replies($are = true)`
* `->before($date)`
Expand All @@ -37,7 +40,7 @@ This is the list of filters avaliables:


## 3. Delete Tweets
In order to delete tweets from your timeline, the implementantion is:
In order to delete tweets from your timeline, the implementation is:
```php
use Tuiter\TweetDestroyer;

Expand Down

0 comments on commit 40ff066

Please sign in to comment.