aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..76ffd51
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Vox Populi - A Tumblr Web Client
+A quick and easy web client for Tumblr written in PHP.
+
+## Installation
+1. To create a Tumblr application and get your consumer key/secret pair, [create an app on the Tumblr site](https://www.tumblr.com/oauth/apps).
+2. Set your environment variables in an `.htaccess` file. For example,
+```
+# Environment Variables
+SetEnv CONSUMER_KEY "<your-consumer-key>"
+SetEnv CONSUMER_SECRET "<your-consumer-secret>"
+```
+3. Git clone this repository into the web directory where you want Voc Populi to be served.
+4. Done! You (and your users) can now login. The site will automatically redirect you to the Tumblr login page if you are not already authenticated.
+