From 34e2639edb4dafd83fb29a27975a15ccf7789e62 Mon Sep 17 00:00:00 2001
From: James Reeves <jreeves@weavejester.com>
Date: Sun, 12 Feb 2012 14:38:52 +0000
Subject: [PATCH] Filled out README

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 57 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 6e76948..88ce717 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,65 @@
-# ring-server
+# Ring-Server
 
-FIXME: write description
+A library for starting a web server to serve a [Ring][1] handler with
+sensible default options and environment variable overrides.
 
-## Usage
+[1]: https://github.com/mmcgrana/ring
 
-FIXME: write
+## Features
+
+When starting in development mode (i.e. `LEIN_NO_DEV` is not set):
+
+* The server finds a free port to start on
+* It automatically reloads changed files
+* It renders exceptions and their stacktraces in HTML
+* A web browser is automatically opened to the started server
+
+In production:
+
+* You can specify the port via the `PORT` environment variable
+* You can add hooks to run on startup and shutdown.
+
+## Install
+
+Add the following dependency to your `project.clj` file:
+
+    [ring-server "0.1.0"]
+
+## Usage 
+
+Simple usage:
+
+```clojure
+(use 'ring.server.standalone)
+(serve your-handler)
+```
+
+You can also specify a map of options:
+
+```clojure
+(serve your-handler {:port 4040})
+```
+
+The following options are supported:
+
+* `:port`    - The port to start the server on, overrides `$PORT`
+
+* `:join?`   - Whether to wait until the server stops (default true)
+
+* `:init`    - A function executed when the server starts
+
+* `:destroy` - A function executed when the server stops
+
+* `:open-browser?` -
+  True if you want a browser to be opened to the server. Defaults to
+  true in development mode, false in production mode.
+
+* `:middleware` -
+  A list of middleware functions to apply to the handler. Defaults to
+  `[wrap-stacktrace wrap-reload]` in development.
 
 ## License
 
-Copyright (C) 2012 FIXME
+Copyright (C) 2012 James Reeves
 
 Distributed under the Eclipse Public License, the same as Clojure.