diff --git a/README.md b/README.md index 52786d5..733057e 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ ## Feature -Add effect according to scroll. +Add effect according to scroll. +By using pre-prepared CSS, it is surprisingly easy to add effects that match the scrolling. <br> @@ -20,7 +21,7 @@ Add effect according to scroll. - npm -> [https://www.npmjs.com/package/js-scroll-effect-module](https://www.npmjs.com/package/js-scroll-effect-module) -- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.13.2/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module@v0.13.2/dist/js-scroll-effect-module.js) +- Standalone(CDN) -> [https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module/dist/js-scroll-effect-module.js](https://cdn.jsdelivr.net/gh/yama-dev/js-scroll-effect-module/dist/js-scroll-effect-module.js) - Zip -> [yama-dev/js-scroll-effect-module](https://github.com/yama-dev/js-scroll-effect-module/releases/latest) @@ -103,7 +104,25 @@ const ScrollEffectModule = new SCROLL_EFFECT_MODULE({ </script> ``` -## API +## Methods + +### Start + +監視を開始 + +ex. `ScrollEffectModule.Start();` + +### Stop + +監視を停止 + +ex. `ScrollEffectModule.Stop();` + +### Update + +各要素の情報更新 + +ex. `ScrollEffectModule.Update();` <br>