Skip to content

Commit

Permalink
Improve docs & fix build badge
Browse files Browse the repository at this point in the history
  • Loading branch information
Drafteed committed Oct 9, 2023
1 parent 6378099 commit a2f47b6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<img src="https://img.shields.io/bundlephobia/min/reeller?color=green" alt="Bundle file size">
<img src="https://img.shields.io/bundlephobia/minzip/reeller?color=yellow&label=gzip%20size" alt="Bundle file size (gzip)">
<a href="https://npmcharts.com/compare/reeller?minimal=true"><img src="https://img.shields.io/npm/dm/reeller?color=blue" alt="NPM Downloads"></a>
<img src="https://img.shields.io/github/workflow/status/Cuberto/reeller/CI" alt="GitHub Workflow Status">
<img src="https://img.shields.io/github/actions/workflow/status/Cuberto/reeller/ci.yml?branch=dev" alt="GitHub Workflow Status">

Flexible, powerful and modern library for creating the running horizontal blocks effect, also known as ticker or the «marquee effect».

Expand Down Expand Up @@ -64,7 +64,7 @@ Reeller requires GSAP to work. You need to import it above the Reeller if you di
<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/3.10.4/gsap.min.js"></script>
<script src="https://unpkg.com/reeller@0/dist/reeller.min.js"></script>
<script>
var reeller = new Reeller({
var reeller = new Reeller.Reeller({
container: '.my-reel',
wrapper: '.my-reel-wrap',
itemSelector: '.my-reel-item',
Expand All @@ -73,6 +73,8 @@ Reeller requires GSAP to work. You need to import it above the Reeller if you di
</script>
```

_Note: All modules (Reeller, Filler, ScrollerPlugin) will be imported into `Reeller` namespace when using from CDN, so you must use a prefix._

## Options

You can configure Reeller via options.
Expand Down

0 comments on commit a2f47b6

Please sign in to comment.