Skip to content

Commit

Permalink
feat: change name to AGM - Angular Google Maps
Browse files Browse the repository at this point in the history
  • Loading branch information
sebholstein committed Apr 9, 2017
1 parent 2788dba commit d1bab5a
Show file tree
Hide file tree
Showing 8 changed files with 42 additions and 34 deletions.
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,42 @@
[![angular2-google-maps](assets/images/angular2-google-maps-logo.png)](https://angular-maps.com/)
[![AGM - Angular Google Maps](assets/images/angular-google-maps-logo.png)](https://angular-maps.com/)

# angular2-google-maps
# AGM - Angular Google Maps

Angular 2+ components for Google Maps.
Angular 2+ components for Google Maps. (Previously known as angular2-google-maps)

-----

**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.

Old package name: `angular2-google-maps`
New package name: `@agm/core`

**==> Please see the [CHANGELOG.md](CHANGELOG.md) file for more migration details.**

----

[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)

-----

[![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)
[![Downloads](http://img.shields.io/npm/dm/angular2-google-maps.svg)](https://npmjs.org/package/angular2-google-maps)

## Playing with angular2-google-maps
---

## Playing with AGM (Angular Google Maps)

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`:
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`:

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

## Installation

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

You can install the package with the following command:

```shell
npm install angular2-google-maps
npm install @agm/core
```

You should also checkout the [Getting started](https://angular-maps.com/docs/getting-started.html#package-installation) guide for further information.
Binary file added assets/images/angular-google-maps-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/angular2-google-maps-logo.png
Binary file not shown.
8 changes: 3 additions & 5 deletions assets/release/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
angular-google-maps - Angular 2+ Google Maps components
Angular Google Maps (AGM) - Angular 2+ Google Maps components
=========

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.

This package contains different sources for different users:

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

License: See LICENSE file in this folder.
4 changes: 2 additions & 2 deletions docs/_partials/homepage/quickstart-example.ejs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BrowserModule } from '@angular/platform-browser';
import { NgModule. Com } from '@angular/core';
import { NgModule, Component } from '@angular/core';

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

@Component({
selector: 'app-root',
Expand Down
18 changes: 9 additions & 9 deletions docs/getting-started.jade
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
include ../_includes/utils

+section_title('Playing with angular-google-maps (AGM)', 'playing')
+section_title('Playing with Angular Google Maps (AGM)', 'playing')
:marked
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`:
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`:

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

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

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

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

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

`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:
`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:

.code-highlight
:marked
```markup
npm install @angular-google-maps/core --save
npm install @agm/core --save
```

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

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

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

The command starts the following things:
* 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)
* Starts a local web server to serve the Angular 2 application. It refreshes the page when served files change.
* Starts a local web server to serve the Angular application. It refreshes the page when served files change.

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

+section_title('Questions?', 'questions')
:marked
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:
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:

a.button.button-icon.blue-light(href='https://gitter.im/SebastianM/angular-google-maps') » Chat on Gitter
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
{
"name": "angular-google-maps-src",
"version": "0.17.0",
"name": "@agm/core-src",

This comment has been minimized.

Copy link
@paulwalker

paulwalker Apr 11, 2017

Should this not be @agm/core

This comment has been minimized.

Copy link
@ratbeard

ratbeard Apr 16, 2017

Yea, it doesn't seem like I can yarn/npm link this currently. I've installed agm/core and my app requires it, but running link refers to agm/core-src:

2017-04-16 at 9 55 25 am

This comment has been minimized.

Copy link
@sebholstein

sebholstein Apr 17, 2017

Author Owner

no thats ok. Build the project with npm run build and look into the dist/ folder. the package name in this dir is correct. The -src suffix is for safety reasons (so that no one can publish the source).

"version": "1.0.0-beta.0",
"description": "Angular 2+ components for Google Maps",
"repository": {
"type": "git",
"url": "https://github.com/SebastianM/angular-google-maps.git"
},
"keywords": [
"angular",
"angular2",
"ng",
"google-maps",
"ng2",
"maps",
"google",
"gmaps"
"gmaps",
"ng2",
"angular2"
],
"scripts": {
"clean": "rimraf dist && rimraf .tmp && mkdir dist && mkdir .tmp && rimraf 'src/**/*.ngfactory.ts'",
Expand Down
6 changes: 2 additions & 4 deletions scripts/create-package-json.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@ pkgNames.forEach(function(pkgName) {
const basePkgJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));

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

// remove scripts
delete basePkgJson.scripts;

// remove devDependencies (as there are important for the sourcecode only)
delete basePkgJson.devDependencies;

// transform dependencies to peerDependencies for the release
basePkgJson.peerDependencies = Object.assign({}, basePkgJson.dependencies);

basePkgJson.dependencies = {};

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

0 comments on commit d1bab5a

Please sign in to comment.