aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a3d8c8d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+twitter-to-atom
+===============
+
+Generate an Atom-Feed from a Twitter account.
+
+Installation / Building
+-----------------------
+
+You need to have the Go programming language installed. After that, installing is as simple as
+
+ go get github.com/kch42/twitter-to-atom
+
+Usage
+-----
+
+ twitter-to-atom user
+
+This generates an Atom feed on stdout with the recent posts and retweets of the Twitter user `@user`.