Skip to content

Commit

Permalink
docs: add feature overview to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaskuske authored Dec 8, 2018
1 parent d2b0d90 commit 1f4cde6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@
 
 

## Features

- ✔ Smooth scroll to target when clicking an anchor
- ✔ Smooth scroll to target on hashchange (◀/▶ buttons)
- ✔ Updates URL with #fragment
- ✔ Handles focus

## Browser support
⚠ Requires smooth scroll for `window.scroll()` and `Element.scrollIntoView()` (e.g. [smoothscroll-polyfill](http://iamdustan.com/smoothscroll/)) to work!

Expand Down

0 comments on commit 1f4cde6

Please sign in to comment.