Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
evanplaice committed Jun 10, 2020
1 parent d72987a commit a2826d7
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
[![GitHub Releases](https://badgen.net/github/tag/vanillawc/wc-marquee)](https://github.com/vanillawc/wc-marquee/releases)
[![NPM Release](https://badgen.net/npm/v/@vanillawc/wc-marquee)](https://www.npmjs.com/package/@vanillawc/wc-marquee)
[![Bundlephobia](https://badgen.net/bundlephobia/minzip/@vanillawc/wc-marquee)](https://bundlephobia.com/result?p=@vanillawc/wc-marquee)
[![MIT License](https://badgen.net/github/license/vanillawc/wc-marquee)](https://raw.githubusercontent.com/vanillawc/wc-marquee/master/LICENSE)
[![Published on WebComponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/vanillawc/wc-marquee)
[![Latest Status](https://github.com/vanillawc/wc-marquee/workflows/Latest/badge.svg)](https://github.com/vanillawc/wc-marquee/actions)
[![Release Status](https://github.com/vanillawc/wc-marquee/workflows/Release/badge.svg)](https://github.com/vanillawc/wc-marquee/actions)

A Vanilla Web Component to resurrect our dearly beloved and sorely missed `<marquee>` element


-----
<h1 align="center">&lt;wc-marquee&gt;: The Marquee Tag as a Web Component</h1>

<div align="center">
<a href="https://github.com/vanillawc/wc-marquee/releases"><img src="https://badgen.net/github/tag/vanillawc/wc-marquee" alt="GitHub Releases"></a>
<a href="https://www.npmjs.com/package/@vanillawc/wc-marquee"><img src="https://badgen.net/npm/v/@vanillawc/wc-marquee" alt="NPM Releases"></a>
<a href="https://bundlephobia.com/result?p=@vanillawc/wc-marquee"><img src="https://badgen.net/bundlephobia/minzip/@vanillawc/wc-marquee" alt="Bundlephobia"></a>
<a href="https://raw.githubusercontent.com/vanillawc/wc-marquee/master/LICENSE"><img src="https://badgen.net/github/license/vanillawc/wc-marquee" alt="MIT License"></a>
<a href="https://www.webcomponents.org/element/vanillawc/wc-marquee"><img src="https://img.shields.io/badge/webcomponents.org-published-blue.svg" alt="Published on WebComponents.org"></a>
<a href="https://github.com/vanillawc/wc-marquee/actions"><img src="https://github.com/vanillawc/wc-marquee/workflows/Latest/badge.svg" alt="Latest Status"></a>
<a href="https://github.com/vanillawc/wc-marquee/actions"><img src="https://github.com/vanillawc/wc-marquee/workflows/Release/badge.svg" alt="Release Status"></a>
</div>

## Installation

*Installation*
```sh
npm i @vanillawc/wc-marquee
```

Then import the `index.js` file at the root of the package.
*Import from NPM*
```html
<script type="module" src="node_modules/@vanillawc/wc-marquee/index.js"></script>
```

*Import from CDN*
```html
<script type="module" src="https://cdn.jsdelivr.net/gh/vanillawc/wc-marquee/index.js"></script>
```

## Demo

-----
Try it on [WebComponents.dev](https://webcomponents.dev/edit/xHimVOHvwKeM64huCe18?sv=1&pm=1)

## Usage

Expand Down Expand Up @@ -52,9 +62,3 @@ Styling can be done using standard css attributes.
This will demonstrate the resplendent joy of HTML in its prime
</wc-marquee>
```

-----

## Demos

### [WC-Marquee - WebComponents.dev](https://webcomponents.dev/edit/xHimVOHvwKeM64huCe18?sv=1&pm=1)

0 comments on commit a2826d7

Please sign in to comment.