Skip to content

Commit

Permalink
WIP Update main README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kenneth G. Franqueiro committed Sep 28, 2018
1 parent ecacefc commit b1c6e83
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,14 @@ npm install @material/ripple
Then import the ES2015 file for @material/ripple into your application, and initialize an MDCRipple with a DOM element:

```js
import {MDCRipple} from '@material/ripple';
import {MDCRipple} from '@material/ripple/index';
const ripple = new MDCRipple(document.querySelector('.foo-button'));
```

> Note: Import `@material/ripple/index` if you wish to transpile MDC Web's ES2015 sources as part of your build process.
> If your build toolchain is configured to only transpile your own sources, import `@material/ripple` instead, which will
> reference the distributed UMD module instead.
This will produce a Material Design ripple on the button!

<img src="docs/button_with_ripple.png" alt="Button with Ripple" width="90" height="36">
Expand Down

0 comments on commit b1c6e83

Please sign in to comment.