Skip to content

Commit 527fa35

Browse files
committed
Updated readme
1 parent 61d1e74 commit 527fa35

File tree

2 files changed

+6
-15
lines changed

2 files changed

+6
-15
lines changed

.github/main.workflow

Lines changed: 0 additions & 9 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,13 +153,13 @@ var scroll = new SmoothScroll('a[href*="#"]', {
153153

154154

155155

156-
## Options and Settings
156+
## API
157157

158158
Smooth Scroll includes smart defaults and works right out of the box. But if you want to customize things, it also has a robust API that provides multiple ways for you to adjust the default options and settings.
159159

160-
### Global Settings
160+
### Options and Settings
161161

162-
You can pass options and callbacks into Smooth Scroll through the `init()` function:
162+
You can pass options and callbacks into Smooth Scroll when instantiating.
163163

164164
```javascript
165165
var scroll = new SmoothScroll('a[href*="#"]', {
@@ -246,7 +246,7 @@ document.addEventListener('scrollCancel', logScrollEvent, false);
246246

247247
### Methods
248248

249-
You can also call Smooth Scroll's methods in your own scripts.
249+
Smooth Scroll also exposes several public methods.
250250

251251
#### animateScroll()
252252
Animate scrolling to an anchor.
@@ -297,15 +297,15 @@ scroll.cancelScroll();
297297
***Note:*** *This does not handle focus management. The user will stop in place, and focus will remain on the anchor link that triggered the scroll.*
298298

299299
#### init()
300-
Initialize Smooth Scroll. This is called automatically when you setup your `new SmoothScroll` object, but can be used to reinitialize your instance.
300+
Initialize Smooth Scroll. This is called automatically when you instantiate your `new SmoothScroll` object, but can be used to reinitialize your instance.
301301

302302
```javascript
303303
var scroll = new SmoothScroll();
304304
scroll.init('.some-selector');
305305
```
306306

307307
#### destroy()
308-
Destroy the current `smoothScroll.init()`. This is called automatically during the `init` function to remove any existing initializations.
308+
Destroy the current initialization. This is called automatically in the `init` method to remove any existing initializations.
309309

310310
```javascript
311311
var scroll = new SmoothScroll();

0 commit comments

Comments
 (0)