← Back to branch summary

~dspiteri/charms/precise/etherpad-lite/pythonport

« back to all changes in this revision

Viewing changes to README.rst

  • Committer: Jorge O. Castro
  • Date: 2013-04-09 18:38:59 UTC
  • Revision ID: jorge@ubuntu.com-20130409183859-kmifl1uk0xor79uu
Fix up README to be Markdown so it renders nice in the store.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.rst
1
 
====================
2
 
Etherpad Lite Rocks!
3
 
====================
4
 
 
5
 
Overview
6
 
--------
7
 
 
8
 
Etherpad lite is a really-real time collaborative editor spawned from the
9
 
Hell fire of Etherpad. It reuses the well tested Etherpad easysync library
10
 
to make it really realtime.
11
 
 
12
 
Etherpad Lite is based on node.js ergo is much lighter and more stable than
13
 
the original Etherpad. Our hope is that this will encourage more users to
14
 
use and install a realtime collaborative editor.
15
 
 
16
 
A smaller, manageable and well documented codebase makes it easier for
17
 
developers to improve the code and contribute towards the project.
18
 
 
19
 
Etherpad Lite is optimized to be eddasy embeddable. It provides a HTTP API
20
 
that allows your web application to manage pads, users and groups. There
21
 
are several clients in for this API:
22
 
 
23
 
 * PHP, thx to TomNomNom
24
 
 * .Net, thx to ja-jo
25
 
 * Node.js, thx to tomassedovic
26
 
 * Ruby, thx to jhollinger
27
 
 * Python, thx to devjones
28
 
 
29
 
There is also a jQuery plugin that helps you to embed Pads into your website
30
 
 
31
 
For more information see https://github.com/Pita/etherpad-lite.
32
 
 
33
 
Usage
34
 
-----
35
 
 
36
 
Etherpad will happily sit on single server::
37
 
 
38
 
   juju deploy etherpad-lite
39
 
 
40
 
but it can also be backed by mysql::
41
 
 
42
 
   juju deploy mysql
43
 
   juju add-relation etherpad-lite mysql
44
 
 
45
 
Note that if you switch an existing etherpad-lite instance to use mysql you will
46
 
lose all of the pads within your standalone deployment - same applies
47
 
vica-versa.
48
 
 
49
 
You can change the upstream commit tag for etherpad-lite by using charm config
50
 
either in a yaml file::
51
 
 
52
 
    etherpad-lite:
53
 
        commit: 1.0
54
 
 
55
 
or::
56
 
 
57
 
    juju set etherpad-lite commit=cfb58a80a30486156a15515164c9c0f4647f165b
58
 
 
59
 
This can be changed for an existing service as well - allowing you to upgrade to
60
 
a newer (potentially broken!) version.