From d2dbb55316ed4303b2ed6aba987bbc92f65e68c1 Mon Sep 17 00:00:00 2001 From: Ritchie Martori Date: Thu, 10 May 2012 13:42:25 -0700 Subject: [PATCH] docs --- docs/index.html | 24 +++++++++++++++++------- docs/index.markdown | 26 ++++++++++++++++++-------- 2 files changed, 35 insertions(+), 15 deletions(-) diff --git a/docs/index.html b/docs/index.html index 5bd4fa1..1c94531 100644 --- a/docs/index.html +++ b/docs/index.html @@ -26,24 +26,34 @@

Instead of reinventing a protocol, deployd embraces HTTP. This means that any HTTP client, such as a JavaScript app, a mobile app, or even another server, can securely interact with your data without having to setup a web server and write a custom backend.

+

Dependencies

+ +

Currently deployd requires mongodb to be installed. You can download it here.

+ +

Deployd also requires node.js >= v0.6.0. You can download it here.

+

Quick start

-

To install deployd locally you must have npm and a running instance of mongodb.

+

Install deployd from npm (requires [nodejs(http://www.mongodb.org/downloads), mongodb).

-
[sudo] npm install deployd -g
+
$ [sudo] npm install deployd -g
 
-

First you'll want to generate an authentication key.

+

Create an index.html file in a new directory.

-
dpd key
+
$ cat >> index.html
+hello world!
+^C
 
-

Copy the key for use in the dashboard. Then start the server.

+

Run deployd from the directory where you want to server your files.

-
dpd listen
+
$ dpd -d
 
-

You can view the dashboard at http://localhost:2403/__dashboard/. It will prompt you for your auth key.

+

This will open up the dashboard where you can manage your deployd server.

+ +

See dpd -h for more info on how to use the command line interface.

How does it work?

diff --git a/docs/index.markdown b/docs/index.markdown index dd594cc..29f06bc 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -4,21 +4,31 @@ Instead of reinventing a protocol, deployd embraces HTTP. This means that any HTTP client, such as a JavaScript app, a mobile app, or even another server, can securely interact with your data without having to setup a web server and write a custom backend. +## Dependencies + +Currently deployd requires mongodb to be installed. You can download it [here](http://www.mongodb.org/downloads). + +Deployd also requires `node.js` >= v0.6.0. You can download it [here](http://nodejs.org/#download). + ## Quick start -To install deployd locally you must have `npm` and a running instance of mongodb. +Install deployd from npm (requires [nodejs(http://www.mongodb.org/downloads), [mongodb](http://nodejs.org/#download)). - [sudo] npm install deployd -g + $ [sudo] npm install deployd -g -First you'll want to generate an authentication key. +Create an `index.html` file in a new directory. - dpd key + $ cat >> index.html + hello world! + ^C + +Run deployd from the directory where you want to server your files. + + $ dpd -d -Copy the key for use in the dashboard. Then start the server. +This will open up the dashboard where you can manage your deployd server. - dpd listen - -You can view the dashboard at `http://localhost:2403/__dashboard/`. It will prompt you for your auth key. +See `dpd -h` for more info on how to use the command line interface. ## How does it work?