Skip to content

Commit 502b2be

Browse files
authored
now on NPM 🔥
1 parent 489799e commit 502b2be

4 files changed

Lines changed: 18 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,25 @@ You can work with any HTML Element far beyond anchor tags.
1818

1919
## Getting started
2020
### Installation
21-
[Download](https://github.com/bfiessinger/scrollToSmooth/archive/master.zip) the repository and include the production ready code from the <code>dist</code> folder in your project.
2221

23-
Include the script in your code:
24-
```html
25-
<script src="path/to/scrolltosmooth.min.js"></script>
26-
```
22+
#### NPM
23+
`npm install scrollToSmooth`
2724

28-
or use a CDN:
25+
#### From a CDN
2926
```html
3027
<script src="https://cdn.jsdelivr.net/gh/bfiessinger/scrollToSmooth@latest/dist/scrolltosmooth.min.js"></script>
3128
<!-- OR -->
3229
<script src="https://cdn.jsdelivr.net/gh/bfiessinger/scrollToSmooth@{VERSION}/dist/scrolltosmooth.min.js"></script>
3330
```
3431

32+
#### Download
33+
[Download](https://github.com/bfiessinger/scrollToSmooth/archive/master.zip) the repository and include the production ready code from the <code>dist</code> folder in your project.
34+
35+
Include the script in your code:
36+
```html
37+
<script src="path/to/scrolltosmooth.min.js"></script>
38+
```
39+
3540
## Usage
3641
```javascript
3742
let smoothScroll = new scrollToSmooth('a', {
@@ -263,4 +268,4 @@ data contains an object with values for `startPosition` and `endPosition`
263268
15+ ✔ | 7+ ✔ | 10+ ✔ | 12+ ✔ | 15+ ✔ | 6+ ✔ |
264269

265270
### Polyfills
266-
Support for older browsers requires a polyfill for <code>requestAnimationFrame()</code>
271+
Support for older browsers requires a polyfill for `requestAnimationFrame()`

‎changelog.MD‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
### 2.1.3
4+
- Fixed wrong compiled code
5+
- Published NPM Release
6+
37
### 2.1.2
48
- Bugfix: linear easing not working
59

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "scrolltosmooth",
3-
"version": "2.1.2",
3+
"version": "2.1.3",
44
"description": "a vanilla JS smooth scroll to anchor script",
55
"main": "src/scrolltosmooth.js",
66
"scripts": {

‎rollup.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { terser } from 'rollup-plugin-terser';
55
const prettier = require('rollup-plugin-prettier');
66

77
const srcScript = 'src/scrolltosmooth.js';
8-
const version = '2.1.2';
8+
const version = '2.1.3';
99
const banner = '/**\n\
1010
* Vanilla JS Smooth Scroll\n\
1111
* Author: Bastian Fießinger\n\

0 commit comments

Comments
 (0)