Skip to content

Commit

Permalink
README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
tomnomnom committed Sep 11, 2012
1 parent 65525ad commit a9a7856
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
@@ -1,33 +1,34 @@
This PHP Etherpad Lite class allows you to easily interact with Etherpad Lite API with PHP. Etherpad Lite is a collaborative editor provided by the Etherpad Foundation. http://etherpad.org
# PHP Etherpad Lite Client
This PHP Etherpad Lite class allows you to easily interact with Etherpad Lite API with PHP.
Etherpad Lite is a collaborative editor provided by the Etherpad Foundation (http://etherpad.org)

#1 Basic usage
## Basic usage

<pre>
include 'etherpad-lite-client.php';
$instance = new EtherpadLiteClient('EtherpadFTW,http://beta.etherpad.org/api');
$instance = new EtherpadLiteClient('EtherpadFTW', 'http://beta.etherpad.org/api');
$revisionCount = $instance->getRevisionsCount('testPad');
$revisionCount = $revisionCount->revisions;
echo "Pad has $revisionCount revisions\n\n";
</pre>

#2 Examples
## Examples

See it live here http://beta.etherpad.org/example_big.php
See it live here: http://beta.etherpad.org/example\_big.php

Examples are located in examples.php and example_big.php. examples.php contains an example for each API call. example_big.php contains a UI for managing pads.
Examples are located in examples.php and example\_big.php.
examples.php contains an example for each API call.
example\_big.php contains a UI for managing pads.

This example is the most commonly used, the example displays a pads text on the screen:

<pre>
$padContents = $instance->getText('testPad');
echo "Pad text is: <br/><ul>$padContents->text\n\n</ul>";
echo "End of Pad Text\n\n<hr>";
</pre>

#3 License
# License

Apache License

#4 Other stuff
# Other stuff

The Etherpad Foundation also provides a jQuery plugin for Etherpad Lite. This can be found at http://etherpad.org/2011/08/14/etherpad-lite-jquery-plugin/
The Etherpad Foundation also provides a jQuery plugin for Etherpad Lite.
This can be found at http://etherpad.org/2011/08/14/etherpad-lite-jquery-plugin/

0 comments on commit a9a7856

Please sign in to comment.