From 79738e11d786a7cbc8ac7e7f9cf9e876aca4be1b Mon Sep 17 00:00:00 2001
From: Tim Keane <t.d.keane@gmail.com>
Date: Thu, 20 Apr 2017 17:50:32 -0400
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6f83ea02
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# nyc-lib
+
+A set of common libraries used to develop NYC mapping applications
+
+### Geocoding
+
+* To use ```nyc.Geoclient``` as the implementation of ```nyc.Geocoder``` you must first get your Geoclient App ID and App Key from the [NYC Developer Portal](https://developer.cityofnewyork.us/api/geoclient-api)
+  * Register if you don't have an NYC Developer Portal account
+  * Developer Management > View or Create a New Project...
+  * Configure [Gradle](http://gradle.org/)
+    * Set ```git.geoclient.url='//maps.nyc.gov/geoclient/v1/search.json?app_key=YOUR_APP_KEY&app_id=YOUR_APP_ID'``` in ```$GRADLE_USER_HOME/gradle.properties```
+    * Set ```test.geoclient.url='//maps.nyc.gov/geoclient/v1/search.json?app_key={actual App Key}&app_id={actual App ID}'``` in ```$GRADLE_USER_HOME/gradle.properties```
+
+## Tests
+* Run ```gradle jettyRun``` or ```gradlew jettyRun``` and navigate your browser to ```http://localhost:8088/src/main/test/``` to run [QUnit](https://qunitjs.com/) tests
+* To successfully run test ```nyc.Geocoder.search (address)``` you must configure [Gradle](http://gradle.org/) ass describe above
+
+## Build
+* ```gradlew buildLibs```
+	* builds libraries ```nyc-ol-lib.js```, ```nyc-ol-redline-lib.js```, ```nyc-leaf-lib.js```, ```nyc.carto-lib.js```
+* ```gradlew jsDoc``` 
+	* builds [JsDoc](http://usejsdoc.org/)
+* ```gradlew archive``` 
+	* builds and zips libraries ```nyc-ol-lib.js```, ```nyc-ol-redline-lib.js```, ```nyc-leaf-lib.js```, ```nyc.carto-lib.js``` with [JsDoc](http://usejsdoc.org/)