diff --git a/LEGACY.md b/LEGACY.md index 17b4e57e..2c2a73d9 100644 --- a/LEGACY.md +++ b/LEGACY.md @@ -4,15 +4,11 @@ ### CDN Support -The folks over at [MaxCDN](https://www.maxcdn.com) have graciously provided CDN support. +Previously, MaxCDN provided support for V1 of the Twemoji API. MaxCDN shut down on December 31, 2022. -Use the following in the `` tag of your HTML document(s): +Support for V1 of the Twemoji API is no longer available and is not planned. Please migrate to V2. -```html - -``` - -This guarantees that you are using the V1 version of the library. +The rest of this README is kept around for historical purposes and may not work as described. ### Download diff --git a/README.md b/README.md index d7a93bc3..85a49f3a 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,19 @@ The Twemoji library offers support for all Unicode-defined emoji which are recom ### CDN Support -The folks over at [MaxCDN](https://www.maxcdn.com) have graciously provided CDN support. - -MaxCDN is shut down right now, so in the meanwhile use a different CDN or download the assets. (See [Maxcdn has shut down, cdn not working anymore. · Issue #580 · twitter/twemoji](https://github.com/twitter/twemoji/issues/580)). +Default CDN support is provided via [jsDelivr](https://www.jsdelivr.com/). Use the following in the `` tag of your HTML document(s): ```html - + ``` 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 - + ``` ### Download @@ -61,7 +59,7 @@ var img = div.querySelector('img'); // note the div is preserved img.parentNode === div; // true -img.src; // https://twemoji.maxcdn.com/v/latest/72x72/2764.png +img.src; // https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/72x72/2764.png img.alt; // \u2764\uFE0F img.className; // emoji img.draggable; // false @@ -78,7 +76,7 @@ Here's the list of properties accepted by the optional object that can be passed { callback: Function, // default the common replacer attributes: Function, // default returns {} - base: string, // default MaxCDN + base: string, // default jsDelivr ext: string, // default ".png" className: string, // default "emoji" size: string|number, // default "72x72" @@ -136,7 +134,7 @@ twemoji.parse(genericNode, { }); ``` -This will generate urls such `https://twemoji.maxcdn.com/svg/2764.svg` instead of using a specific size based image. +This will generate urls such `https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/2764.svg` instead of using a specific size based image. ## Utilities diff --git a/index.d.ts b/index.d.ts index da76b2ce..c8d73da2 100644 --- a/index.d.ts +++ b/index.d.ts @@ -13,7 +13,7 @@ export type ReplacerFunction = (substring: string, ...args: any[]) => string; export type TwemojiOptions = { /** - * Default: Cloudflare + * Default: jsDelivr */ base?: string; /** diff --git a/index.html b/index.html index 6649d817..8df6b3f3 100644 --- a/index.html +++ b/index.html @@ -44,7 +44,7 @@

Code licensed under MIT. Graphics licensed under CC-BY

- + +