Skip to content

Commit d1bab5a

Browse files
sebholsteinsebholstein
committed
feat: change name to AGM - Angular Google Maps
1 parent 2788dba commit d1bab5a

8 files changed

Lines changed: 42 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,42 @@
1-
[![angular2-google-maps](assets/images/angular2-google-maps-logo.png)](https://angular-maps.com/)
1+
[![AGM - Angular Google Maps](assets/images/angular-google-maps-logo.png)](https://angular-maps.com/)
22

3-
# angular2-google-maps
3+
# AGM - Angular Google Maps
44

5-
Angular 2+ components for Google Maps.
5+
Angular 2+ components for Google Maps. (Previously known as angular2-google-maps)
6+
7+
-----
8+
9+
**CAUTION:** The project name has changed from `angular2-google-maps` maps to `AGM - Angular Google Maps` because [#itsJustAngular](http://angularjs.blogspot.de/2017/01/branding-guidelines-for-angular-and.html) and we want to support all upcomming Angular versions.
10+
11+
Old package name: `angular2-google-maps`
12+
New package name: `@agm/core`
13+
14+
**==> Please see the [CHANGELOG.md](CHANGELOG.md) file for more migration details.**
15+
16+
----
617

718
[Website](https://angular-maps.com/) | [Demo](http://plnkr.co/edit/YX7W20?p=preview) | [Chat](https://gitter.im/SebastianM/angular2-google-maps) | [API Documentation](https://angular-maps.com/docs/api/latest/ts/) | [Twitter](https://twitter.com/Sebamueller)
819

920
-----
1021

1122
[![Build Status](https://travis-ci.org/SebastianM/angular2-google-maps.svg?branch=master)](https://travis-ci.org/SebastianM/angular2-google-maps) [![Join the chat at https://gitter.im/SebastianM/angular2-google-maps](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/SebastianM/angular2-google-maps?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![npm version](https://badge.fury.io/js/angular2-google-maps.svg)](http://badge.fury.io/js/angular2-google-maps)
12-
[![Downloads](http://img.shields.io/npm/dm/angular2-google-maps.svg)](https://npmjs.org/package/angular2-google-maps)
1323

14-
## Playing with angular2-google-maps
24+
---
25+
26+
## Playing with AGM (Angular Google Maps)
1527

16-
If you just want to play with `angular2-google-maps` and don't want to set up a full project, you can use the following Plunker. It has all the dependencies to play with Angular, Typescript and of course `angular2-google-maps`:
28+
If you just want to play with AGM and don't want to set up a full project, you can use the following Plunker. It has all the dependencies to play with Angular, Typescript and of course `AGM`:
1729

18-
[» Play with angular2-google-maps on Plunker](http://plnkr.co/edit/YX7W20?p=preview)
30+
[» Play with Angular Google Maps on Plunker](http://plnkr.co/edit/YX7W20?p=preview)
1931

2032
## Installation
2133

22-
angular2-google-maps gets shipped via the Node Package Manager. So make sure that you have [NodeJS](https://nodejs.org) installed.
34+
`AGM` gets shipped via the Node Package Manager. So make sure that you have [NodeJS](https://nodejs.org) installed.
2335

2436
You can install the package with the following command:
2537

2638
```shell
27-
npm install angular2-google-maps
39+
npm install @agm/core
2840
```
2941

3042
You should also checkout the [Getting started](https://angular-maps.com/docs/getting-started.html#package-installation) guide for further information.

‎assets/images/angular-google-maps-logo.png‎

48.2 KB
Loading

‎assets/images/angular2-google-maps-logo.png‎

-75 KB
Binary file not shown.

‎assets/release/README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
angular-google-maps - Angular 2+ Google Maps components
1+
Angular Google Maps (AGM) - Angular 2+ Google Maps components
22
=========
33

44
The sources for this package are in the [angular-google-maps](https://github.com/SebastianM/angular-google-maps) repository. Please file issues and pull requests against that repo.
55

66
This package contains different sources for different users:
77

8-
1. The files located in the root dir are ES5 compatible files that can be consumed using CommonJS.
9-
2. The files under `/esm` are ES5 based with ES2015 modules.
10-
3. The files under `/ts` are the TypeScript source files.
11-
4. Files with the name pattern *.umd.js are UMD bundled modules for fast load times during development.
8+
1. The files located in the root dirare ES5 based with ES2015 modules.
9+
1. Files with the name pattern *.umd.js are UMD bundled modules for fast load times during development.
1210

1311
License: See LICENSE file in this folder.

‎docs/_partials/homepage/quickstart-example.ejs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { BrowserModule } from '@angular/platform-browser';
2-
import { NgModule. Com } from '@angular/core';
2+
import { NgModule, Component } from '@angular/core';
33

4-
import { AgmCoreModule } from '@angular-google-maps/core';
4+
import { AgmCoreModule } from '@agm/core';
55

66
@Component({
77
selector: 'app-root',

‎docs/getting-started.jade‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
include ../_includes/utils
22

3-
+section_title('Playing with angular-google-maps (AGM)', 'playing')
3+
+section_title('Playing with Angular Google Maps (AGM)', 'playing')
44
:marked
5-
If you just want to play with AGM and don't want to set up a full project with NPM, you can use the following Plunker. It has all the dependencies to play with Angular 2, Typescript and of course `angular-google-maps`:
5+
If you just want to play with AGM and don't want to set up a full project with NPM, you can use the following Plunker. It has all the dependencies to play with Angular, Typescript and of course `angular-google-maps`:
66

77
a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') » Play with angular-google-maps on Plunker
88

@@ -14,7 +14,7 @@ a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') &r
1414
:marked
1515
**If you're familiar with setting up Angular projects with Angular CLI & TypeScript, you can skip this part and move on to this part:**
1616

17-
**[Setting up angular-google-maps (AGM)](#angular-google-maps-setup)**
17+
**[Setting up Angular Google Maps (AGM)](#angular-google-maps-setup)**
1818

1919
:marked
2020
### Installing TypeScript
@@ -33,7 +33,7 @@ a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') &r
3333
.code-highlight
3434
:marked
3535
```markup
36-
npm install -g angular-cli
36+
npm install -g @angular/cli
3737
```
3838

3939
:marked
@@ -51,12 +51,12 @@ a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') &r
5151
:marked
5252
### Install angular-google-maps
5353

54-
`angular-google-maps (short name: AGM)` gets shipped via the Node Package Manager (NPM). Run the following command to add it to your new project:
54+
`Angular Google Maps (short name: AGM)` gets shipped via the Node Package Manager (NPM). Run the following command to add it to your new project:
5555

5656
.code-highlight
5757
:marked
5858
```markup
59-
npm install @angular-google-maps/core --save
59+
npm install @agm/core --save
6060
```
6161

6262
:marked
@@ -73,7 +73,7 @@ a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') &r
7373
import { FormsModule } from '@angular/forms';
7474
import { AppComponent } from './app.component';
7575

76-
import { AgmCoreModule } from '@angular-google-maps/core';
76+
import { AgmCoreModule } from '@agm/core';
7777

7878
@NgModule({
7979
imports: [
@@ -166,12 +166,12 @@ a.button.button-icon.blue-light(href='http://plnkr.co/edit/YX7W20?p=preview') &r
166166

167167
The command starts the following things:
168168
* Starts the TypeScript compiler and compiles all sources files (watches also for file changes in the source files and recompiles all files if something has changed)
169-
* Starts a local web server to serve the Angular 2 application. It refreshes the page when served files change.
169+
* Starts a local web server to serve the Angular application. It refreshes the page when served files change.
170170

171171
**When everything works as expected, you should see your first Google Map created with AGM 🎉🎉🎉!**
172172

173173
+section_title('Questions?', 'questions')
174174
:marked
175-
When you have problems setting up **angular-google-maps** or questions in general, the best way is to join the chat where you find nice people from the community that can answer you questions:
175+
When you have problems setting up **angular-google-maps (AGM)** or questions in general, the best way is to join the chat where you find nice people from the community that can answer you questions:
176176

177177
a.button.button-icon.blue-light(href='https://gitter.im/SebastianM/angular-google-maps') » Chat on Gitter

‎package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
2-
"name": "angular-google-maps-src",
3-
"version": "0.17.0",
2+
"name": "@agm/core-src",
3+
"version": "1.0.0-beta.0",
44
"description": "Angular 2+ components for Google Maps",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/SebastianM/angular-google-maps.git"
88
},
99
"keywords": [
1010
"angular",
11-
"angular2",
1211
"ng",
1312
"google-maps",
14-
"ng2",
1513
"maps",
1614
"google",
17-
"gmaps"
15+
"gmaps",
16+
"ng2",
17+
"angular2"
1818
],
1919
"scripts": {
2020
"clean": "rimraf dist && rimraf .tmp && mkdir dist && mkdir .tmp && rimraf 'src/**/*.ngfactory.ts'",

‎scripts/create-package-json.js‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@ pkgNames.forEach(function(pkgName) {
1010
const basePkgJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
1111

1212
// define the package name
13-
basePkgJson.name = `@angular-google-maps/${pkgName}`
13+
basePkgJson.name = `@agm/${pkgName}`
1414

1515
// remove scripts
1616
delete basePkgJson.scripts;
1717

1818
// remove devDependencies (as there are important for the sourcecode only)
1919
delete basePkgJson.devDependencies;
20-
21-
// transform dependencies to peerDependencies for the release
22-
basePkgJson.peerDependencies = Object.assign({}, basePkgJson.dependencies);
20+
2321
basePkgJson.dependencies = {};
2422

2523
const filepath = path.join(__dirname, `../dist/${pkgName}/package.json`);

0 commit comments

Comments
 (0)