From 2a7c5d16102a9bb89b236c82c397bf8587d03917 Mon Sep 17 00:00:00 2001
From: Geert Josten <geert.josten@marklogic.com>
Date: Mon, 21 Sep 2015 17:47:16 +0200
Subject: [PATCH] Fixed #2/#7: updated README

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 964e92d..44ce32a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,32 @@
 # marklogic-typescript-definitions
 TypeScript Definition files for MarkLogic built-in functions, available as npm module
 
-INITIAL CRUDE ATTEMPT, EXPECT ERRORS! Please suggest improvements!
\ No newline at end of file
+## Usage
+
+Install these files as nodejs dependency using npm:
+
+```
+npm install marklogic-typescript-definitions --save
+```
+
+TypeScript enabled editors should pick up the TypeScript definition files automatically
+
+## Editor
+
+- (Visual Studio Code)[https://code.visualstudio.com/] runs out of the box with this.
+- (Atom)[https://atom.io/] also provides good support (if not better), but requires installation of a TypeScript plugin.
+
+## Building the typescript definitions
+
+- Clone this project
+- Create a folder xml/
+- Download a copy of the documentation from here: http://docs.marklogic.com/MarkLogic_8_pubs.zip
+- Extract the zip, and copy the contents of the folder pubs/raw/apidoc/ into xml/ 
+- Run `npm install`
+- Run `gulp` (may take a few minutes)
+
+Note: you likely want to override ml-host, ml-user, and such. It runs by default as if you typed:
+
+```
+gulp --ml-host=ml8-ml1 --ml-port=8000 --ml-user=admin --ml-pass=admin
+```