Skip to content

Commit

Permalink
Rewrite readme.md
Browse files Browse the repository at this point in the history
Add usage and correct wording.
  • Loading branch information
saketi0906 committed Sep 16, 2019
1 parent 98eb40f commit 1ae03a9
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@ Simple and lightweight size scroll library.

# Installing
~~~
npm install plainScroll
npm install plain-scroll
~~~

# Usage
PlainScroll is simple to usage. Insert the following code into your project.
PlainScroll is simple to usage. If you are using a module bundler, insert the following code into your project.
~~~
import PlainScroll from 'plainScroll';
import PlainScroll from 'plain-scroll';
~~~
Please use plain-scroll.min.js when using with script tag.
~~~
<script src="plain-scroll.min.js"></script>
~~~
Next, create a instance.
~~~
Expand Down

0 comments on commit 1ae03a9

Please sign in to comment.