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

Commit

Permalink
Small fixes to the readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
dmfrancisco committed Jul 14, 2011
1 parent 020ef0c commit 67f941f
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
@@ -1,6 +1,6 @@
![escrito logo](http://dmfranc.com/assets/escrito.png)

## Check the demo at
## Demonstration
[http://escrito.herokuapp.com/](http://escrito.herokuapp.com/)


Expand Down Expand Up @@ -29,6 +29,7 @@ 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.

escrito --database redis
Expand All @@ -38,7 +39,7 @@ For more detailed help type:
escrito -h


## Install it locally
## Local installation

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

Expand All @@ -49,6 +50,7 @@ Start the server:
npm start escrito

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
Expand All @@ -65,11 +67,6 @@ Install all the dependencies.
cd escrito
npm install

Build them.

cake build-dependencies
cake build

Run the server:

coffee web.coffee
Expand Down

0 comments on commit 67f941f

Please sign in to comment.