Added markdown version of readme

1 files changed, 42 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b6aff7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+#blapaste
+
+Very simple pastebin clone written in PHP
+
+##Author
+Joe Robinson
+
+Source code of [p.of.je](http://p.of.je)
+
+This is a simple web site where you can paste text and access it via a 
+browser. Just go to http://p.of.je, type/paste text into the form, and 
+press submit. It will then take you to a page with your text on a page 
+with a short URL.
+
+Can also be used with [pastebinit](https://launchpad.net/pastebinit) 
+which should be available in package managers for most Linux distros. 
+After installing pastebinit, copy the p.of.je.conf file into 
+/usr/share/pastebin.d then can be used with -b p.of.je, e.g -
+
+df -h | pastebinit -b http://p.of.je
+
+Will copy the output of df -h to http://p.of.je, then return the URL 
+where it can be viewed
+
+Alternatively, host it yourself
+
+#Installation
+
+##Requirements
+
+PHP (Tested with 5.5, assumed to work with any recent version)
+An HTTP Server (Tested with Apache 2.2)
+
+##Instructions
+
+Clone this repository into a directory
+Configure your HTTP server so that the directory can be accessed via a 
+browser
+Ensure the HTTP server has write access to the directory
+Navigate to the directory in your browser, then follow the usage 
+instructions above
+