Permalink
Browse files

Readme file added

  • Loading branch information...
1 parent d26fd96 commit 2fa5c6c01cebab82f94d1df7017b73de66f8d199 @dmfrancisco committed Jul 14, 2011
Showing with 86 additions and 0 deletions.
  1. +86 −0 README.md
View
@@ -0,0 +1,86 @@
+![escrito logo](http://dmfranc.com/assets/escrito.png)
+
+## Check the demo at
+[http://escrito.herokuapp.com/](http://escrito.herokuapp.com/)
+
+
+## Installation
+
+If you want to install escrito, you'll need coffee.
+ npm install -g coffee-script
+
+Check if everything went okay.
+ coffee -v
+
+Next, run:
+ npm install -g escrito
+
+Then start the server.
+ escrito
+
+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.
+ escrito --database redis
+
+For more detailed help type:
+ escrito -h
+
+
+## Install it locally
+
+You can also install escrito locally. This will install it in your current directory.
+ npm install escrito
+
+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
+
+
+## From source
+
+You can clone the github repository.
+ git clone git://github.com/dmfrancisco/escrito.git
+
+Install all the dependencies.
+ cd escrito
+ npm install
+
+Build them.
+ cake build-dependencies
+ cake build
+
+Run the server:
+ coffee web.coffee
+
+Again, you can pass custom arguments.
+ coffee web.coffee --port 4567 --database redis
+
+
+# Compiling CoffeeScripts
+
+If you want to compile the CoffeeScripts to JavaScript.
+ cake build-dependencies
+ cake build
+
+Run the server:
+ node web.js
+
+
+# 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
+* [Ace Editor](https://github.com/ajaxorg/ace/) - Textarea enriched by Mozilla
+* [Markdown mode](https://github.com/fivesixty/notepages/) - Support added by Chris Spencer
+* [Showdown](https://github.com/fivesixty/mdext/) - Markdown parser made by John Fraser
+* [Textile parser](https://github.com/miebach/js-textile/) - Textile parser made by Ben Daglish
+* [Google Caja](http://code.google.com/p/google-caja/) - HTML Sanitizer
+Check them all in the [humans.txt](http://escrito.herokuapp.com/humans.txt) file.

0 comments on commit 2fa5c6c

Please sign in to comment.