Skip to content
This repository has been archived by the owner on Dec 1, 2020. It is now read-only.

Commit

Permalink
publish to NPM
Browse files Browse the repository at this point in the history
cleaned up package.json and added scripts
updated release script to use scripts and include publish step
updated README w/ npm install instructions
updated CHANGELOG

resolves #80
  • Loading branch information
tomwayson committed Sep 9, 2015
1 parent 080f5a0 commit 3ef1568
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 18 deletions.
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).

[Upcoming changes][unreleased]

None.
### Maintenance

Published to NPM [#80](/~https://github.com/Esri/angular-esri-map/issues/80)

## [Beta 4](v1.0.0-beta.4)

### Added

* The esriMap directive's additonal map options now support advanced options such as Extent and Popup. /~https://github.com/Esri/angular-esri-map/pull/71
* The esriMap directive's additional map options now support advanced options such as Extent and Popup. /~https://github.com/Esri/angular-esri-map/pull/71

### Changed

* The esriMap directive now reads additonal map options by scope function binding, and these options are passed into the construction of a map from a webmapId. /~https://github.com/Esri/angular-esri-map/pull/71
* The esriMap directive now reads additional map options by scope function binding, and these options are passed into the construction of a map from a webmapId. /~https://github.com/Esri/angular-esri-map/pull/71
* Changes to accommodate a thorough review of the map directive life cycle, and adjustments to make sure all properties are updated and events fired as expected. /~https://github.com/Esri/angular-esri-map/pull/76
* Several existing docs and test pages updated ([web map example](http://esri.github.io/angular-esri-map/#/examples/web-map) includes a legend).

Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ Here are [a few examples](http://esri.github.io/angular-esri-map/) showing how y

### Quick Start

To use these directives in your own Angular application, first install the module as a dependency using bower:
To use these directives in your own Angular application, first install the module as a dependency using any of the following methods.

```bash
# install via bower
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.
# OR install via npm
npm install angular-esri-map
```
Alternatively, you can clone or [download](/~https://github.com/Esri/angular-esri-map/releases) 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.
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 "path/to/angular-esri-map.js" to point to the location of the file in your environment and load the page in a browser.

![App](https://raw.github.com/Esri/angular-esri-map/master/angular-esri-map.png)

Expand Down
14 changes: 10 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@
"version": "1.0.0-beta.4",
"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"
},
"dependencies": {},
"devDependencies": {
"browser-sync": "~1.6.1",
"gh-release": "^2.0.1",
"gulp": "^3.8.9",
"gulp-clean": "~0.3.0",
"gulp-concat": "~2.2.0",
Expand All @@ -32,13 +30,21 @@
"author": "Tom Wayson <twayson@esri.com> (http://tomwayson.com)",
"contributors": [
"Javier Abadía <javier.abadia@esri.es> (/~https://github.com/jabadia)",
"Dave Bouwman <DBouwman@esri.com> (/~https://github.com/dbouwman)",
"Patrick Arlt <parlt@esri.com> (http://patrickarlt.com)",
"Matt Priour <mpriour@esr.com> (/~https://github.com/mpriour)",
"Jacob Wasilkowski <JWasilkowski@esri.com> (/~https://github.com/jwasil)",
"Tom Wayson <twayson@esri.com> (http://tomwayson.com)"
],
"license": "Apache",
"bugs": {
"url": "/~https://github.com/Esri/angular-esri-map/issues"
},
"homepage": "/~https://github.com/Esri/angular-esri-map"
"homepage": "/~https://github.com/Esri/angular-esri-map",
"scripts": {
"build": "gulp build",
"test": "gulp lint",
"release": "./scripts/release.sh",
"start": "gulp"
}
}
12 changes: 5 additions & 7 deletions scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@
VERSION=$(node --eval "console.log(require('./package.json').version);")
NAME=$(node --eval "console.log(require('./package.json').name);")

# TODO: build and test
# npm test || exit 1
# build and test
npm test || exit 1

# checkout temp branch for release
git checkout -b gh-release

# run prepublish to build files
# npm run prepublish
gulp build
# run build
npm run build

# force add files
git add dist -f
Expand All @@ -24,7 +23,6 @@ git commit -m "build $VERSION"
git push upstream gh-release

# create a ZIP archive of the dist files
# zip -r $NAME-v$VERSION.zip dist
7z a -r $NAME-v$VERSION.zip dist

# run gh-release to create the tag and push release to github
Expand All @@ -36,4 +34,4 @@ git branch -D gh-release
git push upstream :gh-release

# publish release on NPM
# npm publish
npm publish

0 comments on commit 3ef1568

Please sign in to comment.