]> git.madduck.net Git - code/twitter-archiver.git/blobdiff - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / code / twitter-archiver.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
README updates
[code/twitter-archiver.git] / README.md
diff --git a/README.md b/README.md
index 12188d6d9fb7656eac62b2c2606dd41f387c937c..ce4dda2dcb2c467255c7857bf96dc03939eec197 100644 (file)
--- 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
 
Set of scripts to facilitate archiving your Twitter life

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.