From 9c173895aeca7f2f9b4ac9f6eb08e5322e9ac689 Mon Sep 17 00:00:00 2001
From: Matthew Scragg <scragg@gmail.com>
Date: Wed, 3 Sep 2014 22:25:48 -0500
Subject: [PATCH] readme updated install script updated

---
 README.md  | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 install.sh |  2 +-
 2 files changed, 72 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9a50252..1e10cc0 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,75 @@
-# Realms Wiki
+# Realms Wiki Beta
+
+Git based wiki written in Python
+Inspired by Gollum, Ghost, and Dillinger.
+Basic authentication and registration included.
+
+## Features
+
+- Built with Bootstrap 3
+- Currently Markdown (w/ HTML) only
+- Syntax highlighting (Ace Editor)
+- Live preview
+- Collaboration (TogetherJS)
+- Drafts saved to localstorage
+
+## Screenshots
+
+TODO thumbnails here
+
+## Requirements
+- Python 2.7
+- Git
+- NodeJS (needed for bower/cleancss, distro packages shouldn't need this in future)
+
+** Optional **
+- Nginx (if you want proxy requests, this is recommended)
+- Memcached or Redis, default is memonization
+- MariaDB, MySQL, Postgresql, or another database supported by SQLAlchemy, default is sqlite.  
+Anon or single user does not require a database.
 
 ## Installation
-
-### Ubuntu
+Install script only tested with Ubuntu 14.04.
+Please refer to the script for package requisites if needed
 
 ```
-sudo apt-get install -y python-dev build-essential git libpcre3-dev libevent-dev python-pip python-virtualenv curl libxml2-dev libxslt1-dev zlib1g-dev libffi-dev
-```
\ No newline at end of file
+git clone https://github.com/scragg0x/realms-wiki
+cd realms-wiki
+sudo bash install.sh
+```
+
+**Nginx**
+
+```sudo apt-get install -y nginx```
+
+TODO nginx config here
+
+## Running
+
+Current there are different ways.
+
+- Daemon mode using upstart
+
+```sudo start realms-wiki```
+
+- Foreground mode
+
+```realms-wiki run```
+
+- Debug mode
+
+```realms-wiki runserver```
+
+Access from your browser
+
+```http://localhost:5000```
+
+## Vagrant
+
+```
+git clone https://github.com/scragg0x/realms-wiki
+cd realms-wiki
+vagrant up
+vagrant ssh
+realms-wiki runserver
+```
diff --git a/install.sh b/install.sh
index 4ecad1b..5e843a0 100644
--- a/install.sh
+++ b/install.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Provision script created for Ubuntu 14.04
-APP_DIR=/vagrant
+APP_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 echo "Provisioning..."