diff --git a/README.md b/README.md index c36ab1d..54c616f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# twitter-timeline-cleaner +# Twitter timeline cleaner Clean your Twitter timeline + +Before run, remember to set those environment variables: + +> export TWITTER_ACCESS_TOKEN='' +> export TWITTER_ACCESS_TOKEN_SECRET='' +> export TWITTER_CONSUMER_KEY='' +> export TWITTER_CONSUMER_SECRET='' +> export TWITTER_NAME='@[your_twitter_name]' + +and follow instructions how to claim a [Twitter developers account](https://developer.twitter.com/en/apply) and [how to create your app](https://developer.twitter.com/en/apps/create), needed to fetch tokens and keys to your Twitter timeline. + +Work inspired by [delete-tweets](https://github.com/koenrh/delete-tweets) by Koen Rouwhorst