Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Minor markup changes made to the README file

  • Loading branch information...
commit e8692b9101364edd866f9bd5ab4854b5819da098 1 parent ddf5ab9
@dmfrancisco authored
Showing with 13 additions and 15 deletions.
  1. +13 −15 README.md
View
28 README.md
@@ -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
@@ -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
@@ -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.
@@ -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.
@@ -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.
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.