Skip to content

Commit 71c718b

Browse files
committed
adjust readme
1 parent 65f5f04 commit 71c718b

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
## Feature
88

9-
Add effect according to scroll.
9+
Add effect according to scroll.
10+
By using pre-prepared CSS, it is surprisingly easy to add effects that match the scrolling.
1011

1112
<br>
1213

@@ -20,7 +21,7 @@ Add effect according to scroll.
2021

2122
- npm -> [https://www.npmjs.com/package/js-scroll-effect-module](https://www.npmjs.com/package/js-scroll-effect-module)
2223

23-
- 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)
24+
- 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)
2425

2526
- Zip -> [yama-dev/js-scroll-effect-module](https://github.com/yama-dev/js-scroll-effect-module/releases/latest)
2627

@@ -103,7 +104,25 @@ const ScrollEffectModule = new SCROLL_EFFECT_MODULE({
103104
</script>
104105
```
105106

106-
## API
107+
## Methods
108+
109+
### Start
110+
111+
監視を開始
112+
113+
ex. `ScrollEffectModule.Start();`
114+
115+
### Stop
116+
117+
監視を停止
118+
119+
ex. `ScrollEffectModule.Stop();`
120+
121+
### Update
122+
123+
各要素の情報更新
124+
125+
ex. `ScrollEffectModule.Update();`
107126

108127
<br>
109128

0 commit comments

Comments
 (0)