Skip to content
This repository has been archived by the owner on Feb 12, 2018. It is now read-only.

Commit

Permalink
Minor markup changes made to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
dmfrancisco committed May 14, 2013
1 parent ddf5ab9 commit e8692b9
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
![escrito logo](http://dmfranc.com/assets/escrito.png)

## Live preview
[http://escrito.herokuapp.com/](http://escrito.herokuapp.com/)

Also available at the [Chrome Web Store](https://chrome.google.com/webstore/detail/gjdfjkicccgkhmifgkilkpbbbadejddb).
[**escrito.herokuapp.com**](http://escrito.herokuapp.com/) (also available at the [Chrome Web Store](https://chrome.google.com/webstore/detail/gjdfjkicccgkhmifgkilkpbbbadejddb))


## Installation and Usage

First make sure you have a working copy of [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) (the node package manager).

First make sure you have a working copy of [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/)
(the node package manager).
To install escrito you'll need coffee.

npm install -g coffee-script
Expand All @@ -26,15 +25,14 @@ Then start the server.

escrito

That should be enough!

That should be enough!
You can pass custom arguments:

escrito --port 4567

Documents are not persistent by default but you can set a custom database type.

The available options are 'memory' and 'redis'. Those are the database types supported by the [ShareJS](https://github.com/josephg/ShareJS/) project.
Documents are not persistent by default but you can set a custom database type.
The available options are 'memory' and 'redis'. Those are the database types supported by
the [ShareJS](https://github.com/josephg/ShareJS/) project.

escrito --database redis

Expand All @@ -43,7 +41,7 @@ For more detailed help type:
escrito -h


## Local installation
#### Local installation

You can also install escrito locally. This will install it in your current directory.

Expand All @@ -53,14 +51,13 @@ Start the server:

npm start escrito

To pass custom arguments using npm, you have to use a slightly different syntax.

To pass custom arguments using npm, you have to use a slightly different syntax.
For example, to set up the server with a custom port you should do the following:

npm config set escrito:port 5000


## From source
#### From source

You can clone the github repository.

Expand All @@ -80,7 +77,7 @@ Again, you can pass custom arguments.
coffee web.coffee --port 4567 --database redis


# Compiling CoffeeScripts
#### Compiling CoffeeScripts

If you want to compile the CoffeeScripts to JavaScript.

Expand All @@ -91,8 +88,9 @@ Run the server:

node web.js

---

# This wouldn't be possible without Open Source projects like
### This wouldn't be possible without Open Source projects like:

* [NodeJS](http://nodejs.org/) - Evented I/O for V8 JavaScript
* [ShareJS](https://github.com/josephg/ShareJS/) - The collaborative editing engine by Joseph Gentle
Expand Down

0 comments on commit e8692b9

Please sign in to comment.