From d3cf9523241f0bd8c8f594c80ff229fbf05a2a8a Mon Sep 17 00:00:00 2001
From: Peter Johnson <wiz@wiz.co.nz>
Date: Fri, 12 Sep 2014 20:00:39 +0100
Subject: [PATCH] readme

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..9b648860
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# API
+
+Pelias RESTful API
+
+## Install Dependencies
+
+```bash
+$ npm install
+```
+
+## Documentation
+
+Documentation is provided as [generated markdown](https://github.com/pelias/api/tree/master/docs):
+
+## Contributing
+
+Please fork and pull request against upstream master on a feature branch.
+
+Pretty please; provide unit tests and script fixtures in the `test` directory.
+
+### Start Server
+
+```bash
+$ npm start
+```
+
+### Running Unit Tests
+
+```bash
+$ npm run unit
+```
+
+### Running Functional Tests
+
+```bash
+$ npm run ciao
+```
+
+### Running All Tests
+
+```bash
+$ npm test
+```
+
+### Generate API Documentation
+
+```bash
+$ npm run docs
+```
+
+### Continuous Integration
+
+Travis tests every release against node version `0.10`
+
+[![Build Status](https://travis-ci.org/pelias/api.png?branch=master)](https://travis-ci.org/pelias/api)
\ No newline at end of file