Permalink
Browse files

[docs] update

  • Loading branch information...
1 parent 2f1b523 commit dcea9a304a359c35423297214901c366276aee72 Paolo Fragomeni committed Jan 13, 2012
Showing with 13 additions and 3 deletions.
  1. +13 −3 README.md
  2. BIN img/director.png
View
@@ -1,11 +1,21 @@
-# Director [![Build Status](https://secure.travis-ci.org/flatiron/director.png)](http://travis-ci.org/flatiron/director)
-# Overview
-Director is a router. Routing is the process of determining what code to run when a URL is requested. Director works on the client and the server. Director is dependency free, on the client it does not require any other libraries (such as jQuery).
+<img src="https://github.com/flatiron/director/raw/master/img/director.png" />
+## Synopsis
+Director is a router. Routing is the process of determining what code to run when a URL is requested.
+
+## Motivation
+A routing library that works in both the browser and node.js environments with as few differences as possible. Simplifies the development of Single Page Apps and Node.js applications. Dependency free (doesn't require jQuery or Express, etc).
+
+## Status
+[![Build Status](https://secure.travis-ci.org/flatiron/director.png)](http://travis-ci.org/flatiron/director)
+
+## Features
* [Client-Side Routing](#client-side)
* [Server-Side HTTP Routing](#http-routing)
* [Server-Side CLI Routing](#cli-routing)
+
+## Usage
* [API Documentation](#api-documentation)
* [Frequently Asked Questions](#faq)
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dcea9a3

Please sign in to comment.