aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdam Mathes <adam@trenchant.org>2017-03-05 09:44:17 -0800
committerAdam Mathes <adam@trenchant.org>2017-03-05 09:44:17 -0800
commit89c3766ded0cc23ecdcf29a69b55ca649ff55049 (patch)
tree0358bc36f1aec1c232760ffdf16a84211870688e
parent7aeea0357d7664b250288a8fd0834449b9d14e3c (diff)
update readmeHEADmaster
-rw-r--r--readme.md25
1 files changed, 17 insertions, 8 deletions
diff --git a/readme.md b/readme.md
index f120965..42adafc 100644
--- a/readme.md
+++ b/readme.md
@@ -1,20 +1,29 @@
# unloved_tweets
-This is a simple script to delete your tweets after a few minutes if nobody likes them.
+Delete your tweets after a few minutes if nobody likes them.
Never face the embarrassment of a zero-starred tweet again!
-## installation
+## Installation
-install dependencies (modern python, tweepy)
+Install dependencies (modern python, tweepy)
-## configuration
+ * python (tested) with 2.7
+ * [tweepy](http://www.tweepy.org)
-copy example_settings.py to settings.py and fill in the required twitter api keys
+Clone this repo
-## running
+ $ git clone https://github.com/adammathes/unloved_tweets.git
-by default it runs in DEBUG mode and DELETES NOTHING
+## Configuration
+
+Copy example_settings.py to settings.py
+
+Fill in the required twitter api keys and make adjustments
+
+## Running
+
+By default it runs in DEBUG mode and DELETES NOTHING
Verify it's working reasonably with -
@@ -30,7 +39,7 @@ you probably will want to put this in your crontab with something like
The MIT License (MIT)
-Copyright (c) 2015 Adam Mathes
+Copyright (c) 2017 Adam Mathes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal