From b1c6e8355a4eaa432dd79e1b7b084e78f2efccfe Mon Sep 17 00:00:00 2001 From: "Kenneth G. Franqueiro" Date: Fri, 28 Sep 2018 09:08:03 -0400 Subject: [PATCH] WIP Update main README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff5c39074a2..6d0abcc5bb8 100644 --- a/README.md +++ b/README.md @@ -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! Button with Ripple