added dependencies and resources sections to readme. new screen shot

Esri · Nov 10, 2014 · 2f4f84e · 2f4f84e
1 parent efcf611
commit 2f4f84e
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,24 @@
 angular-esri-map
 ================
 
-A collection of directives to help you use Esri maps and services in your Angular apps.
+A collection of directives to help you use Esri maps and services in your Angular applications.
 
-### Demos
-Here are [a few demos](http://esri.github.io/angular-esri-map/) showing how to use this module to bring Esri maps into your own Angular applications.
+These directives can be used as-is if your mapping needs are simple, or as reference examples of the patterns that you can use to write your own directives that use the ArcGIS API for JavaScript. [Read more...](http://esri.github.io/angular-esri-map/#/about)
 
-### Example
-Here is a quick example to get you started. Just change the paths to point to the proper libraries and go.
+## Getting started
+Here are [a few examples](http://esri.github.io/angular-esri-map/) showing how you can use this module to bring Esri maps into your own Angular applications.
+
+### Quick Start
+
+To use these directives in your own Angular application, first install the module as a dependency using bower:
+
+```bash
+bower install angular-esri-map
+```
+
+Or clone or download this repo and copy the desired module file (`angular-esri-map.js` or `angular-esri-map.min.js`) into your application.
+
+Once you've added the module to your application, you can use the sample code below to use the map and feature layer directives. Just change the paths to point to the locations of the libraries in your environment and go.
 
 ![App](https://raw.github.com/Esri/angular-esri-map/master/angular-esri-map.png)
 
@@ -21,15 +32,14 @@ Here is a quick example to get you started. Just change the paths to point to th
         <link rel="stylesheet" type="text/css" href="http://js.arcgis.com/3.11/esri/css/esri.css">
     </head>
     <body ng-controller="MapController">
-        <h2>Feature Layers Example</h2>
-        <esri-map id="map" center="map.center" zoom="map.zoom" basemap="topo">
-            <esri-feature-layer url="http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Portland_Parks/FeatureServer/0"></esri-feature-layer>
-            <esri-feature-layer url="http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Heritage_Trees_Portland/FeatureServer/0"></esri-feature-layer>
-        </esri-map>
-        <p>Lat: {{ map.center.lat | number:3 }}, Lng: {{ map.center.lng | number:3 }}, Zoom: {{map.zoom}}</p>
+    <esri-map id="map" center="map.center" zoom="map.zoom" basemap="topo">
+        <esri-feature-layer url="http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Portland_Parks/FeatureServer/0"></esri-feature-layer>
+        <esri-feature-layer url="http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Heritage_Trees_Portland/FeatureServer/0"></esri-feature-layer>
+    </esri-map>
+    <p>Lat: {{ map.center.lat | number:3 }}, Lng: {{ map.center.lng | number:3 }}, Zoom: {{map.zoom}}</p>
         <script type="text/javascript" src="http://js.arcgis.com/3.11compact"></script>
         <script src="http://ajax.googleapis.com/ajax/libs/angularjs/1.2.16/angular.js"></script>
-        <script src="../dist/angular-esri-map.js"></script>
+        <script src="path/to/angular-esri-map.js"></script>
         <script type="text/javascript">
             angular.module('esri-map-example', ['esri.map'])
                 .controller('MapController', function ($scope) {
@@ -46,16 +56,33 @@ Here is a quick example to get you started. Just change the paths to point to th
 </html>
 ```
 
-### Development Instructions
+See the documentation for [examples](http://esri.github.io/angular-esri-map/#examples) of how to use the other directives.
+
+## Development Instructions
 
 Make sure you have [Node](http://nodejs.org/) and  [Gulp](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md#getting-started) installed.
 
 1. [Fork and clone this repo](https://help.github.com/articles/fork-a-repo)
 2. `cd` into the `angular-esri-map` folder
-5. Install the dependencies with `npm install`
-5. run `gulp` from the command line. This will start watching the source files and running linting and build commands.
-6. Browse to the example pages under the `examples` folder
-7. Make your changes and create a [pull request](https://help.github.com/articles/creating-a-pull-request)
+3. Install the dependencies with `npm install`
+4. run `gulp` from the command line. This will run the linting and build commands and then start a local web server hosting the application under the `docs` folder
+5. Modify the directive source files (under `src`) or documentation (under `docs`) and your browser will automatically reload as you save your changes
+6. Make a [pull request](https://help.github.com/articles/creating-a-pull-request) to contribute your changes
+
+## Dependencies
+
+These directives were built using Angular v1.2 (specifically 1.2.16) and the ArcGIS API for JavaScript v3.11. They will likely work with other verstions of those frameworks, but have not been tested outside of the above versions.
+
+You will need [Node](http://nodejs.org/) and [Gulp](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md#getting-started) to do local development.
+
+## Resources
+
+* [Angular JS](https://angularjs.org/)
+* [ArcGIS API for JavaScript](//js.arcgis.com)
+* [ArcGIS for Developers](http://developers.arcgis.com)
+* [ArcGIS REST API](http://resources.arcgis.com/en/help/arcgis-rest-api/)
+* [Importing Data Into Feature Services](https://developers.arcgis.com/tools/csv-to-feature-service/)
+* [@Esri](http://twitter.com/esri)
 
 ## Issues
 

diff --git a/angular-esri-map.png b/angular-esri-map.png
diff --git a/bower.json b/bower.json
@@ -8,7 +8,7 @@
     "Matt Priour <[email protected]> (https://github.com/mpriour)",
     "Tom Wayson <[email protected]> (http://tomwayson.com)"
   ],
-  "description": "A collection of directives to help you use Esri maps and services in your Angular apps",
+  "description": "A collection of directives to help you use Esri maps and services in your Angular applications",
   "main": ["dist/angular-esri-map.js", "angular-esri-map.min.js"],
   "keywords": [
     "Angular",

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "angular-esri-map",
   "version": "0.0.1-beta.1",
-  "description": "A collection of directives to help you use Esri maps and services in your Angular apps",
+  "description": "A collection of directives to help you use Esri maps and services in your Angular applications",
   "main": "dist/angular-esri-map.js",
   "directories": {
     "example": "examples"