From: martin f. krafft Date: Sat, 10 Aug 2019 01:27:43 +0000 (+0200) Subject: README updates X-Git-Url: https://git.madduck.net/code/twitter-archiver.git/commitdiff_plain?pf=code README updates --- diff --git a/README.md b/README.md index 12188d6..ce4dda2 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,35 @@ These are a set of scripts allowing you to keep a copy of your Twitter life: All of this is very hackish, but if it's of any use to you, then great! +## Getting started + +I think it's just running the scripts. For instance, I have the following +entries in crontab: + +``` +*/6 * * * * $HOME/twitter/fetch_tweets.sh 2>/dev/null +*/15 * * * * $HOME/twitter/track_followers.sh >/dev/null +2 7 * * * $HOME/twitter/report_followers.sh +``` + +Warning: I have not tested this as a means to extract past tweets. You might +well hit limits of Twitter. However, Twitter does let you export your entire +history to a Zip file. I've done that, and so should you. Then please write +a translator to squeeze all those data into the archive created with my +scripts, and submit a patch. + ## Patches -Patches welcome, please send them to madduck@madduck.net using +Speaking of: patches welcome, please send them to madduck@madduck.net using git-format-patch and git-send-email. ## Wishlist 0. Setup instructions -1. Dumping favourites/starred tweets -2. Dumping bookmarks -3. Exporting parameters (such as email address) to configuration +1. Better handling of target directories, i.e. don't make them subdirectories +2. Exporting parameters (such as email address) to configuration +3. Dumping favourites/starred tweets +4. Dumping bookmarks ## Copyright