From b8191c6a99ec45c1159cc093259d85b16da61236 Mon Sep 17 00:00:00 2001
From: ekardnam <ekarndam@autistici.org>
Date: Wed, 24 Jul 2019 16:59:00 +0200
Subject: [PATCH] Add 'README.md'

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3353441
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# XTweet
+Converts noisy toots to tiny tweets
+
+## Configuration and deployment
+Create a file named `config.js` in the folder with this structure
+```
+module.exports = {
+  twitter_consumer_key: '...',
+  twitter_consumer_secret: '...',
+  twitter_access_token: '...',
+  twitter_access_token_secret: '...',
+
+  mastodon_token: '...',
+  mastodon_user: 'ekardnam',
+  instance: 'mastodon.bida.im',
+}
+```
\ No newline at end of file