From: Antonio Ospite <ospite@studenti.unina.it>
Date: Sat, 27 Jul 2013 14:36:36 +0000 (+0200)
Subject: Update the documentation to use URLs as arguments
X-Git-Tag: v0.1~24
X-Git-Url: https://git.ao2.it/tweeper.git/commitdiff_plain/b2f1cdf72ffcd59a01dabb97273d233c6b5cbb25?hp=2e7583665208a9ca40d3d0fc7a481178084e2870

Update the documentation to use URLs as arguments

This change of behaviour of the interface makes the implementation of
multi-site support a lot easier.
---

diff --git a/README b/README
index 870a210..925bb28 100644
--- a/README
+++ b/README
@@ -25,16 +25,16 @@ whom you are friend to.
 [1] http://www.urbandictionary.com/define.php?term=TWEEPER&defid=3743173
 
 Tweeper can be used via web or as a command line program, for example as
-a filter in your feed reader, by passing the user's "screen name" (without the
-'@') as the first argument.
+a filter in your feed reader, by passing the URL of the user's public timeline
+as the first argument.
 
 Example of use on the command line:
 
-  $ php tweeper.php NSACareers
+  $ php tweeper.php http://twitter.com/NSACareers
 
 Example of use as a Liferea[2] filter:
 
-  $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php NSAcareers"
+  $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://twitter.com/NSAcareers"
 
 [2] http://lzone.de/liferea/