Skip to content

Commit 93e1d68

Browse files
committed
docs(project): updated the readme
1 parent 7a1804a commit 93e1d68

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

README.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -60,33 +60,19 @@ View all the directives and components in action at [https://angular-material-ex
6060
## Dependencies
6161
* [Angular](https://angular.io) (*requires* Angular 2 or higher)
6262

63-
<a name="peerDependencies"/>
64-
65-
### Requirements (peer dependencies):
6663
for the directive as standalone you just need to install the agm core module
6764
- [agm - angular google maps v1.0.0-beta.5](https://www.npmjs.com/package/@agm/core)
6865

6966
```bash
7067
npm i @agm/core
7168
```
7269

73-
for the ui input component, please consider to install the following packages
74-
- [angular material v7.x](https://www.npmjs.com/package/@angular/material)
75-
- [angular cdk v7.x](https://www.npmjs.com/package/@angular/cdk)
76-
- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)
77-
- [angular forms v7.x](https://www.npmjs.com/package/@angular/forms)
70+
optional
7871

7972
```bash
80-
npm i @angular/cdk @angular/material @angular/animations @angular/forms
73+
npm i -D @types/googlemaps
8174
```
8275

83-
<a name="additional-requirements-material-theme"/>
84-
85-
### Additional requirements Theme (Material Design)
86-
- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)
87-
88-
----
89-
9076
<a name="installation"/>
9177

9278
## [Installation](https://angular-material-extensions.github.io/google-maps-autocomplete/getting-started)
@@ -108,6 +94,29 @@ Now install `@angular-material-extensions/google-maps-autocomplete` via:
10894
npm install --save @angular-material-extensions/google-maps-autocomplete
10995
```
11096

97+
<a name="peerDependencies"/>
98+
99+
### Requirements (peer dependencies):
100+
101+
for the ui input component, please consider to install the following packages
102+
- [angular animations v7.x](https://www.npmjs.com/package/@angular/animations)
103+
- [angular forms v7.x](https://www.npmjs.com/package/@angular/forms)
104+
105+
if your are not using the directive but the `mat-google-maps-autocomplete` component
106+
- [angular material v7.x](https://www.npmjs.com/package/@angular/material)
107+
- [angular cdk v7.x](https://www.npmjs.com/package/@angular/cdk)
108+
109+
```bash
110+
npm i @angular/cdk @angular/material @angular/animations @angular/forms
111+
```
112+
113+
<a name="additional-requirements-material-theme"/>
114+
115+
### Additional requirements Theme (Material Design)
116+
- [angular material theme](https://material.angular.io/guide/getting-started#step-4-include-a-theme)
117+
118+
----
119+
111120
##### SystemJS
112121
>**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.
113122
In your systemjs config file, `map` needs to tell the System loader where to look for `@angular-material-extensions/google-maps-autocomplete`:
@@ -144,15 +153,11 @@ export class AppModule {
144153
Other modules in your application can simply import ` MatGoogleMapsAutocompleteModule `:
145154

146155
```js
147-
import { AgmCoreModule } from '@agm/core';
148156
import { MatGoogleMapsAutocompleteModule } from '@angular-material-extensions/google-maps-autocomplete';
149157

150158
@NgModule({
151159
declarations: [OtherComponent, ...],
152160
imports: [
153-
AgmCoreModule.forRoot({
154-
apiKey: 'YOUR_KEY'
155-
}),
156161
MatGoogleMapsAutocompleteModule, ...],
157162
})
158163
export class OtherModule {

0 commit comments

Comments
 (0)