Improved the README

pull/35/head
Peter 'Pita' Martischka 2011-06-30 18:43:27 +01:00
parent 95b47b4940
commit 0d41b4b445
1 changed files with 20 additions and 7 deletions

View File

@ -3,17 +3,30 @@ Etherpad lite is a really-real time collaborative editor spawned from the Hell f
We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite 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 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 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 documented codebase makes it easier for developers to improve the code. Etherpad Lite is optimized
to be easy embeddable
**Online demo**<br> **Online demo**<br>
Visit <http://pitapoison.de:9001> to test it live Visit <http://pitapoison.de:9001> to test it live
# Why use Etherpad Lite? # Etherpad vs Etherpad Lite
* Tiny server hardware footprint <table>
* Pure Javascript client and server side <tr>
* Simplfied interface <td>&nbsp;</td><td>&nbsp;</td><td><b>Etherpad</b></td><td>&nbsp;</td><td><b>Etherpad Lite</b></td>
* Easy to embed </tr>
* Well documented <tr>
<td align="right">Size of the folder (without git history)</td><td>&nbsp;</td><td>30 MB</td><td>&nbsp;</td><td>1.5 MB</td>
</tr>
<tr>
<td align="right">Languages used server side</td><td>&nbsp;</td><td>Javascript (Rhino), Java, Scala</td><td>&nbsp;</td><td>Javascript (node.js)</td>
</tr>
<tr>
<td align="right">Lines of server side Javascript code</td><td>&nbsp;</td><td>101410</td><td>&nbsp;</td><td>5330</td>
</tr>
<tr>
<td align="right">RAM Usage immediately after start</td><td>&nbsp;</td><td>257 MB</td><td>&nbsp;</td><td>16 MB</td>
</tr>
</table>
# Installation # Installation
1. Download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>. <br>THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION. 1. Download latest node.js version from <http://nodejs.org/> and build it with this instructions <https://github.com/joyent/node/wiki/Installation>. <br>THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION.