Skip to content

Commit ab5c915

Browse files
allenhwkimallenhwkim
committed
Merge pull request allenhwkim#410 from Jonfor/master
README updates
2 parents aa80626 + 4a762e9 commit ab5c915

File tree

2 files changed

+74
-71
lines changed

2 files changed

+74
-71
lines changed

‎CHANGELOG.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Release Notes
2+
===============
3+
# 1.14.0
4+
5+
* Prepared for Angular2 transition by removing all scopes
6+
* NgMap service is introduced
7+
* Refactored
8+
9+
# 1.13.0
10+
11+
* New directive `custom-marker`
12+
13+
# 1.12.0
14+
15+
* Refactored documentation with angular-jsdoc
16+
17+
# 1.10.0
18+
19+
* Added an event `objectChanged` to broadcast change of objects in map. e.g., markers, shapes, etc
20+
21+
# 1.9.0
22+
23+
* Refactored directory structure
24+
25+
# 1.7.0
26+
27+
* added **directions** directive
28+
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/directions.html)
29+
* added **places-auto-complete** for input tag.
30+
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/places-auto-complete.html)
31+
32+
# 1.6.0
33+
34+
* added **street-view-panorama** directive with its examples;
35+
[street view with marker](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/street-view-panorama.html) and
36+
[street view in its own container](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/street-view-panorama_container.html)
37+
38+
# 1.5.0
39+
40+
* added **geo-callback attribute** for map, marker, shape, and info-window.
41+
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/map_with_current_position.html)
42+
43+
# 1.4.0
44+
45+
* support lazy loading of maps js with directive, **map-lazy-load**, which does not require to `https://maps.google.com/maps/api/js`
46+
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/map-lazy-load.html)
47+
48+
# 1.3.0
49+
50+
* added **drawing-manager** directive. Thanks to Fangming Du
51+
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/drawing-manager.html)
52+
53+
# 1.2.0
54+
55+
* events with `controller as` syntax, thanks to Simon
56+
57+
# 1.1.0
58+
59+
* marker directive can have icon attribute as JSON
60+
* map with init-event attribute for initialization by an event
61+
62+
# 1.0.0
63+
* Cover all official google maps v3 examples using directives.

‎README.md‎

Lines changed: 11 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,17 @@ For Bower users,
3838

3939
`$ bower install ngmap`
4040

41-
1. Include `ng-map.min.js` as well as google maps.
41+
1. Include `ng-map.min.js`:
42+
`<script src="/bower_components/ngmap/build/scripts/ng-map.min.js"></script>`
43+
44+
2. Include Google maps:
4245
`<script src="http://maps.google.com/maps/api/js"></script>`
4346

44-
2. name angular app as ngMap, or add it as a dependency
47+
2. Name your angular app ngMap, or add it as a dependency
4548

4649
`var myApp = angular.module('myApp', ['ngMap']);`
4750

48-
To get map instance, use `NgMap.getMap()` function
51+
To get the map instance use the `NgMap.getMap()` function
4952

5053
app.controller('MyController', function(NgMap) {
5154
NgMap.getMap().then(function(map) {
@@ -57,17 +60,17 @@ To get map instance, use `NgMap.getMap()` function
5760

5861
Lazy Loading of Google Maps Javascript
5962
---------------------------------------
60-
Simply wrap the map tag with `map-lazy-load="http://maps.google.com/maps/api/js"`.
63+
Simply wrap the map tag with `map-lazy-load="https://maps.google.com/maps/api/js"`.
6164

62-
<div map-lazy-load="http://maps.google.com/maps/api/js">
65+
<div map-lazy-load="https://maps.google.com/maps/api/js">
6366
<ng-map center="41,-87" zoom="3"></ng-map>
6467
</div>
6568

6669
If you need to pass in an API key to the javascript, you can set a scope
67-
variable in your controller (e.g. `$scope.googleMapsUrl="http://maps.google.com/maps/api/js?v=3.20&client=XXXXenter-api-keyXXXX";`).
70+
variable in your controller (e.g. `$scope.googleMapsUrl="https://maps.googleapis.com/maps/api/js?key=YOUR_KEY_HERE";`).
6871
This can be set from a constant value in your app to standardise the API key to pass to google for multiple controllers.
6972

70-
<div map-lazy-load="http://maps.google.com/maps/api/js"
73+
<div map-lazy-load="https://maps.google.com/maps/api/js"
7174
map-lazy-load-params="{{googleMapsUrl}}">
7275
<ng-map center="41,-87" zoom="3"></ng-map>
7376
</div>
@@ -116,74 +119,11 @@ Contributing
116119
- Change to the folder dowloaded
117120
- **npm install** to install the build tools
118121
- **gulp build** to build the javascript & doc files in the /build folder & run the unit tests.
119-
- **gulp clean** to cleanup the repository from a previous build ? does this work ?
122+
- **gulp clean** to cleanup the repository by removing files and folders from previous build.
120123
- **gulp test** to run the Karma unit test suite.
121124
- **gulp test:e2e** to run the Protractor test suite. For the first test run, you may need to update the protractor webdriver manager. It will show the command on screen if this is required (node_modules/gulp-protractor/node_modules/protractor/bin/webdriver-manager update).
122125
- **gulp test:server** will start a web server for the testapp on http://localhost:8888
123126

124-
Release Notes
125-
===============
126-
**1.14.0**
127-
128-
* Prepared for Angular2 transition by removing all scopes
129-
* NgMap service is introduced
130-
* Refactored
131-
132-
**1.13.0**
133-
134-
* New directive `custom-marker`
135-
136-
**1.12.0**
137-
138-
* Refactored documentation with angular-jsdoc
139-
140-
**1.10.0**
141-
142-
* Added an event `objectChanged` to broadcast change of objects in map. e.g., markers, shapes, etc
143-
144-
**1.9.0**
145-
146-
* Refactored directory structure
147-
148-
**1.7.0**
149-
150-
* added **directions** directive
151-
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/directions.html)
152-
* added **places-auto-complete** for input tag.
153-
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/places-auto-complete.html)
154-
155-
**1.6.0**
156-
157-
* added **street-view-panorama** directive with its examples;
158-
[street view with marker](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/street-view-panorama.html) and
159-
[street view in its own container](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/street-view-panorama_container.html)
160-
161-
**1.5.0**
162-
163-
* added **geo-callback attribute** for map, marker, shape, and info-window.
164-
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/map_with_current_position.html)
165-
166-
**1.4.0**
167-
168-
* support lazy loading of maps js with directive, **map-lazy-load**, which does not require to `https://maps.google.com/maps/api/js`
169-
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/map-lazy-load.html)
170-
171-
**1.3.0**
172-
173-
* added **drawing-manager** directive. Thanks to Fangming Du
174-
[Example](https://rawgit.com/allenhwkim/angularjs-google-maps/master/testapp/drawing-manager.html)
175-
176-
**1.2.0**
177-
178-
* events with `controller as` syntax, thanks to Simon
179-
180-
**1.1.0**
181-
182-
* marker directive can have icon attribute as JSON
183-
* map with init-event attribute for initialization by an event
184-
185-
**1.0.0 (covers All official google maps v3 examples using directives).**
186-
187127
license
188128
=======
189129

0 commit comments

Comments
 (0)