Skip to content

Commit

Permalink
docs: remove warning about outdated docs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaskuske committed Dec 8, 2018
1 parent 21c6712 commit cf24d31
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<a href="https://www.npmjs.com/package/smoothscroll-anchor-polyfill"><img align="center" src="https://img.shields.io/npm/v/smoothscroll-anchor-polyfill.svg" alt="NPM version"></a>
<a href="https://travis-ci.org/jonaskuske/smoothscroll-anchor-polyfill"><img align="center" src="https://travis-ci.org/jonaskuske/smoothscroll-anchor-polyfill.svg?branch=master" alt="Build status"></a>
<a href="./LICENSE"><img align="center" src="https://img.shields.io/npm/l/smoothscroll-anchor-polyfill.svg" alt="License"></a>
<a href="https://jonaskuske.github.io/smoothscroll-anchor-polyfill"><img align="center" src="https://img.shields.io/badge/documentation-up--to--date-blue.svg" alt="Documentation"></a>
</p>

&nbsp;
Expand Down Expand Up @@ -77,8 +78,6 @@ import 'smoothscroll-anchor-polyfill';

## Full Documentation & Demo

> ⚠ The documentation is not up-to-date as of now, it will be updated when this packages leaves the beta phase.
The full documentation with advanced installation instructions, limitations, features like enabling and disabling the smooth scrolling and more can be found at
[**jonaskuske.github.io/smoothscroll-anchor-polyfill**](https://jonaskuske.github.io/smoothscroll-anchor-polyfill).
The documentation site itself is built as a smooth scrolling one-page design, utilizing this polyfill.
Expand Down

0 comments on commit cf24d31

Please sign in to comment.