From a8b91b9b40af9338eaabe57105e8afb355d04537 Mon Sep 17 00:00:00 2001
From: Peter 'Pita' Martischka <petermartischka@googlemail.com>
Date: Thu, 7 Apr 2011 14:35:13 +0100
Subject: [PATCH] improve the README

---
 README    | 40 ----------------------------------------
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 40 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 3273b024..00000000
--- a/README
+++ /dev/null
@@ -1,40 +0,0 @@
-Etherpad-Lite
-What is Etherpad Lite?
-Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad.  
-
-Why use Etherpad Lite?
-* Tiny server hardware footprint
-* Pure Javascript client and server side
-* No nasty dependancies
-* Simplfied interface 
-* Easy to embed
-* Well documented
-* Better support for third party editors
-
-What isn't available yet when compared to Etherpad?
-* Timeslider
-* Import/Export
-* Clear authorship colours
-* Upload files
-* View Saved revisions
-* Chat
-* Pad management
-* User management
-* Plugin framework
-
-REQUIREMENTS
-NoteJS - http://nodejs.org/ [apt-get install nodejs]
-NPM[Node Package Manager] - http://npmjs.org [curl http://npmjs.org/install.sh | sh]
-
-INSTALATION
-1. apt-get install nodejs
-2. curl http://npmjs.org/install.sh | sh
-3. npm install socket.io
-
-RUNNING
-1. cd bin
-2. ./run.sh
-
-TESTING
-1. Open your web browser and visit http://IPSERVER:9001
-
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..8cc25b43
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Etherpad-Lite
+What is Etherpad Lite?
+Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad. 
+We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite 
+is based on node.js what makes it much leigther and more stable than the original Etherpad. Our hope 
+is that this will encourage more users to install a realtime collaborative editor. A smaller and well 
+documented codebase makes it easier for developers to improve the code
+
+# Why use Etherpad Lite?
+* Tiny server hardware footprint
+* Pure Javascript client and server side
+* No nasty dependancies
+* Simplfied interface 
+* Easy to embed
+* Well documented
+* Better support for third party editors
+
+# What isn't available YET when compared to Etherpad?
+* Timeslider
+* Import/Export
+* Clear authorship colours
+* Upload files
+* View Saved revisions
+* Chat
+* Pad management
+* User management
+* Plugin framework
+
+# Installation
+1. download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>
+2. install npm [curl http://npmjs.org/install.sh | sh]
+3. install socket.io [npm install socket.io]
+
+# Start
+1. cd bin
+2. ./run.sh
+3. Open your web browser and visit http://IPSERVER:9001
+
+# Contribute
+Look at the TODO list at <https://github.com/Pita/etherpad-lite/wiki/TODO>
+You can get in touch via petermartischka-at-googlemail.com 
+A mailinglist/irc channel will follow later
+