Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Merged
merged 2 commits into from
Jan 30, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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