Update README.md

Author: madelynnblue

README.md

@@ -1,8 +1,23 @@
-node-miniprofiler
-=================
+# node-miniprofiler
 
 Node.js implementation of Stack Exchange's MiniProfiler
 
-#This is a work in progress
+### This is working but not yet considered production ready. Use with caution.
 
-Do not pull this into a production environment, do not open Issues about incomplete implementations.
+# requirements
+
+Currently requires express and connect to run, because it uses `res.on('header', f)` to trigger storing of data, which is a connect thing.
+
+# usage
+
+Clone this repo into your project's node_modules directory. You can also install from npm, but the package may be outdated: https://www.npmjs.org/package/miniprofiler.
+
+Then see [connect_test.js](https://github.com/MiniProfiler/node/blob/master/connect_test.js) for example use.
+
+# Want to help?
+
+Things that need doing:
+
+- remove dependency from express and connect
+- storing of client timings on first result postback (there's a todo in the `results` function about where to do this)
+- document more things