Skip to content

Commit af5530d

Browse files
committed
readme updates for dependencies and 2.2.X
1 parent 3088315 commit af5530d

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

README.markdown

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

2-
We are looking for an active maintainers and or someone to take the "bull by the horns" on the project. @nmccready is active on other projects right now and does not have the time to dedicate to this project as needed. Therefore we are looking for some developers who would like to take the lead on this project. It is totally ripe for a rewrite (3.0, and angular 2.0). Email or private msg (gitter) nmccready if interested.
3-
42
# angular-google-maps
53

64
> AngularJS directives for Google Maps
75
8-
For Pull Requests please see branching scheme below! Realize that PRS to master are for 2.1.X only. If you want it rolled into a 2.0.X release PR to **2.0.X**.
6+
For Pull Requests please see branching scheme below! Realize that PRS to master are for 2.2.X only.
7+
If you want it rolled into a 2.0.X, 2.1.X release PR to **2.0.X** or **2.1.X**.
98

10-
[![Dependencies](https://david-dm.org/angular-ui/angular-google-maps.svg)](https://david-dm.org/angular-ui/angular-google-maps) 
11-
[![Dependencies](https://david-dm.org/angular-ui/angular-google-maps/dev-status.svg)](https://david-dm.org/angular-ui/angular-google-maps) 
9+
[![Dependencies](https://david-dm.org/angular-ui/angular-google-maps.svg)](https://david-dm.org/angular-ui/angular-google-maps) 
10+
[![Dependencies](https://david-dm.org/angular-ui/angular-google-maps/dev-status.svg)](https://david-dm.org/angular-ui/angular-google-maps) 
1211

1312
Master (2.1.X): [![Build Status](https://travis-ci.org/angular-ui/angular-google-maps.svg?branch=master)](https://travis-ci.org/angular-ui/angular-google-maps)
13+
2.2.X: [![Build Status](https://travis-ci.org/angular-ui/angular-google-maps.svg?branch=2.2.X)](https://travis-ci.org/angular-ui/angular-google-maps)
1414
2.1.X: [![Build Status](https://travis-ci.org/angular-ui/angular-google-maps.svg?branch=2.1.X)](https://travis-ci.org/angular-ui/angular-google-maps)
1515
2.0.X: [![Build Status](https://travis-ci.org/angular-ui/angular-google-maps.svg?branch=2.0.X)](https://travis-ci.org/angular-ui/angular-google-maps)
1616

@@ -24,10 +24,22 @@ __________________
2424
## Getting started
2525
This is a set of directives and services for AngularJS `~1.0.7+, ^1.2.2+`.
2626

27+
## Dependencies
28+
29+
In reality you should always be checking the package.json and bower.json as that is the spoken word.
30+
31+
Current Dependencies:
32+
- [lodash](lodash.com)
33+
- [angular](https://github.com/angular/angular.js)
34+
- [angular-simple-logger](https://github.com/nmccready/angular-simple-logger) *as of 2.2.X*
35+
- [google maps sdk](https://developers.google.com/maps/documentation/javascript/3.exp/reference), loaded for you by this directives services
36+
37+
## Development and or Running the Build
38+
2739
If you plan to hack on the directives or want to run the example, first thing to do is to install NPM dependencies:
2840

2941
```shell
30-
npm install #note bower install is run on post install
42+
npm install && bower install
3143
```
3244

3345
* Installing for [Meteor](https://www.meteor.com/) application:
@@ -47,10 +59,10 @@ If you get errors from `jshint` or specs, just add the `--force` argument.
4759

4860
### Generating SourceMap(s)
4961
```shell
50-
grunt mappAll
62+
grunt buildAll
5163
```
52-
This will generate source maps for development (angular-google-maps_dev_mapped.js) (non minified) and source maps to minified
53-
(angular-google-maps_dev_mapped.min.js) files. They each have their own corresponding map files. To get the coinciding source
64+
This will generate source maps for development (angular-google-maps_dev_mapped.js) (non minified) and source maps to minified
65+
(angular-google-maps_dev_mapped.min.js) files. They each have their own corresponding map files. To get the coinciding source
5466
files you will need to copy the generated `/tmp` directory (currently not under scc).
5567

5668
### Running the example
@@ -67,18 +79,21 @@ The various directives are documented at [official site](http://angular-google-m
6779

6880
### Contributing
6981

70-
Filing issues:
82+
Filing issues:
7183
Prior to submiting an issue:
7284
- Search open/**closed** issues, src examples (./examples), gitter, and then google plus community! **Again please search!**
7385
- issues w/ plnkrs get attention quicker
7486

75-
Pull requests more than welcome! If you're adding new features, it would be appreciated if you would provide some docs about the feature.
76-
This can be done either by adding a card to our [Waffle.io board](https://waffle.io/angular-ui/angular-google-maps), forking the website
87+
Pull Requests (PR) more than welcome! If you're adding new features, it would be appreciated if you would provide some docs about the feature.
88+
This can be done either by adding a card to our [Waffle.io board](https://waffle.io/angular-ui/angular-google-maps), forking the website
7789
branch and issuing a PR with the updated documentation page, or by opening an issue for us to add the documentation to the site.
7890

91+
PR's should follow [angular git commit conventions](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
92+
7993
### Branching Scheme
8094

81-
- master: points to the active targeted next release branch (2.1.X)
82-
- 2.0.X: latest of 2.0.X
83-
- 2.1.X: ""
95+
- master: points to the active targeted next release branch (2.2.X)
96+
- 2.2.X: latest of 2.2.X *side note: 2.2.X is basically the same as 2.1.X except the logging dependency has been added*
97+
- 2.1.X: latest of 2.1.X
98+
- 2.0.X: ""
8499
... etc

0 commit comments

Comments
 (0)