Skip to content

Commit ed3640a

Browse files
committed
update readme
1 parent 2b879ad commit ed3640a

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* MdlDialogService and MdlSnackbarService have changed:
2121
- There is no longer a `setDefaultViewContainerRef` method. There are two ways to specify a `ViewContainerRef` where dynamic Components will be attached:
2222
- use `MdlDialogOutletService` and `setDefaultViewContainerRef`
23-
- use the `<dialog-outlet></dialog-outlet>` component. This component can be anywhere in your html site. the best place is the last child of the `body` element. (see https://github.com/mseemann/angular2-mdl/wiki/How-to-use-the-MdlDialogService for more information)
23+
- use the `<dialog-outlet></dialog-outlet>` component. This component can be anywhere in your html site. The best place is the last child of the `body` element. (see https://github.com/mseemann/angular2-mdl/wiki/How-to-use-the-MdlDialogService for more information)
2424
- The possibility to set a `ViewContainerRef` for each dialog or snackbar has been removed.
2525
- `alert` and `confirm` return an `Observable` and no longer a `Promise` (the enum `ConfirmResult` has been removed)
2626
* This version now supports AOT - but you should be aware that AOT seems not to be ready for production. AOT behaves in many cases different then JIT. (see https://github.com/angular/angular/issues/11606)

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Do not take a red flag to serious. Most of the time this is a sauce lab issue an
3030
- Buttons
3131
- Cards
3232
- Chips
33-
- Dialogs (still experimental - e.g. the API is not stable)
33+
- Dialogs (imperative and declarative)
3434
- Icons
3535
- Loading
3636
- Shadow
@@ -55,7 +55,7 @@ npm install angular2-mdl --save
5555

5656
### How to use the mdl components with webpack
5757

58-
Just use it. Add the MdlRootModule to your NgModule imports and you are done!
58+
Just use it. Add the MdlModule to your NgModule imports and you are done!
5959

6060
### How to use the mdl components with system js
6161

@@ -68,7 +68,7 @@ const map: any = {
6868

6969
/** User packages configuration. */
7070
const packages: any = {
71-
'angular2-mdl': { main: 'dist/components/index.js'}
71+
'angular2-mdl': { main: 'components/index.js'}
7272
};
7373
```
7474

@@ -86,19 +86,19 @@ This package includes the scss files from material-design-lite.
8686
With these files you are able to change the colors and other variables in your own scss files:
8787

8888
```scss
89-
@import "color-definitions";
89+
@import "~angular2-mdl/scss/color-definitions";
9090

9191
$color-primary: $palette-blue-500;
9292
$color-primary-dark: $palette-blue-700;
9393
$color-accent: $palette-amber-A200;
9494
$color-primary-contrast: $color-dark-contrast;
9595
$color-accent-contrast: $color-dark-contrast;
9696

97-
@import 'material-design-lite';
97+
@import '~angular2-mdl/scss/material-design-lite';
9898
```
9999

100100
To make this working you need to find out the way how you could tell your build system where the scss is located.
101-
For example with webpack this can be done in this way:
101+
For example with webpack you can use the special `~angular2-mdl` syntax or you can configure the includePaths:
102102

103103
```JavaScript
104104
sassLoader: {

0 commit comments

Comments
 (0)