Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add NPM installation instructions, bump 15.0 versioning to 15.1
  • Loading branch information
jdecked authored Oct 3, 2024
1 parent a6909cf commit 0dfa4d0
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,20 @@

A simple library that provides standard Unicode [emoji](http://en.wikipedia.org/wiki/Emoji) support across all platforms.

**Twemoji v15.0** adheres to the [Unicode 15.0 spec](https://unicode.org/versions/Unicode15.0.0/) and supports the [Emoji 15.0 spec](https://www.unicode.org/reports/tr51/tr51-23.html). _We do not support custom emoji._
**Twemoji v15.1** adheres to the [Unicode 15.1 spec](https://unicode.org/versions/Unicode15.1.0/) and supports the [Emoji 15.1 spec](https://www.unicode.org/reports/tr51/tr51-25.html). _We do not support custom emoji._

The Twemoji library offers support for all Unicode-defined emoji which are recommended for general interchange (RGI).

## Usage

### Install via NPM

Run the following inside of your already-initialized project:

```bash
npm install @twemoji/api
```

### CDN Support

Default CDN support is provided via [jsDelivr](https://www.jsdelivr.com/).
Expand All @@ -22,7 +30,7 @@ This guarantees that you will always use the latest version of the library.

If, instead, you'd like to include the latest version explicitly, you can add the following tag:
```html
<script src="https://cdn.jsdelivr.net/npm/@twemoji/api@15.0.2/dist/twemoji.min.js" integrity="sha384-D6GSzpW7fMH86ilu73eB95ipkfeXcMPoOGVst/L04yqSSe+RTUY0jXcuEIZk0wrT" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/@twemoji/api@15.1.0/dist/twemoji.min.js" integrity="sha384-D6GSzpW7fMH86ilu73eB95ipkfeXcMPoOGVst/L04yqSSe+RTUY0jXcuEIZk0wrT" crossorigin="anonymous"></script>
```

### Download
Expand Down

0 comments on commit 0dfa4d0

Please sign in to comment.