v4.0.2

nfrasser · Oct 2, 2022 · bfacfeb · bfacfeb
1 parent 4d98670
commit bfacfeb
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Linkify Changelog
 
+## v4.0.2
+
+* Fix email address detection with domains containing numbers
+
 ## v4.0.1
 
 * Restore nl2br option for linkify-html

diff --git a/packages/linkify-element/README.md b/packages/linkify-element/README.md
@@ -1,7 +1,9 @@
 linkify-element
 ===
 
-[Linkify](https://linkify.js.org/) DOM Element Interface. Use `linkify-element` to replace links within native HTML elements with anchor tags.
+[![npm version](https://badge.fury.io/js/linkify-element.svg)](https://www.npmjs.com/package/linkify-element)
+
+[Linkify](https://linkify.js.org/) DOM Element Interface. Use `linkify-element` to detect URLs, email addresses and more within native HTML elements and replace them with anchor tags.
 
 Note that `linkify-element` is included with `linkify-jquery`, so you do not have to install it if you are using `linkify-jquery`.
 

diff --git a/packages/linkify-html/README.md b/packages/linkify-html/README.md
@@ -1,7 +1,9 @@
 linkify-html
 ===
 
-[Linkify](https://linkify.js.org/) HTML String Interface. Use `linkify-html` to highlight links within strings that contain HTML markup.
+[![npm version](https://badge.fury.io/js/linkify-html.svg)](https://www.npmjs.com/package/linkify-html)
+
+[Linkify](https://linkify.js.org/) HTML String Interface. Use `linkify-html` to detect URLs, email addresses and more in strings that contain HTML markup and replace them with anchor `<a>` tags.
 
 ## Installation
 

diff --git a/packages/linkify-jquery/README.md b/packages/linkify-jquery/README.md
@@ -1,7 +1,9 @@
 linkify-jquery
 ===
 
-[Linkify](https://linkify.js.org/) jQuery plugin. Also available in vanilla JavaScript via `linkify-element`.
+[![npm version](https://badge.fury.io/js/linkify-jquery.svg)](https://www.npmjs.com/package/linkify-jquery)
+
+[Linkify](https://linkify.js.org/) jQuery plugin. Also available in vanilla JavaScript via `linkify-element`. Use it to detect URLs, email addresses and more and wrap them with anchor `<a>` tags.
 
 ## Installation
 

diff --git a/packages/linkify-plugin-hashtag/README.md b/packages/linkify-plugin-hashtag/README.md
@@ -1,7 +1,9 @@
 linkify-plugin-hashtag
 ===
 
-Detect Twitter-style #hashtags with [Linkify](https://linkify.js.org/).
+[![npm version](https://badge.fury.io/js/linkify-plugin-hashtag.svg)](https://www.npmjs.com/package/linkify-plugin-hashtag)
+
+Detect and convert Twitter-style #hashtags to `<a>` anchor tags with [Linkify](https://linkify.js.org/).
 
 ## Installation
 

diff --git a/packages/linkify-plugin-ip/README.md b/packages/linkify-plugin-ip/README.md
@@ -1,7 +1,9 @@
 linkify-plugin-ip
 ===
 
-Detect IPv4 and IPv6 addresses with [Linkify](https://linkify.js.org/).
+[![npm version](https://badge.fury.io/js/linkify-plugin-ip.svg)](https://www.npmjs.com/package/linkify-plugin-ip)
+
+Detect and convert IPv4 and IPv6 addresses to `<a>` anchor tags with [Linkify](https://linkify.js.org/).
 
 ## Installation
 

diff --git a/packages/linkify-plugin-keyword/README.md b/packages/linkify-plugin-keyword/README.md
@@ -1,7 +1,9 @@
 linkify-plugin-keyword
 ===
 
-Detect arbitrary keywords with [Linkify](https://linkify.js.org/).
+[![npm version](https://badge.fury.io/js/linkify-plugin-keyword.svg)](https://www.npmjs.com/package/linkify-plugin-keyword)
+
+Detect and convert arbitrary keywords to `<a>` anchor tags with [Linkify](https://linkify.js.org/).
 
 ## Installation
 

diff --git a/packages/linkify-plugin-mention/README.md b/packages/linkify-plugin-mention/README.md
@@ -1,7 +1,9 @@
 linkify-plugin-mention
 ===
 
-Detect Twitter- and GitHub- style "at"-mentions (@mentions) with [Linkify](https://linkify.js.org/).
+[![npm version](https://badge.fury.io/js/linkify-plugin-mention.svg)](https://www.npmjs.com/package/linkify-plugin-mention)
+
+Detect and convert Twitter- and GitHub- style "at"-mentions (@mentions) to `<a>` anchor tags with [Linkify](https://linkify.js.org/).
 
 ## Installation
 

diff --git a/packages/linkify-plugin-ticket/README.md b/packages/linkify-plugin-ticket/README.md
@@ -1,7 +1,9 @@
 linkify-plugin-ticket
 ===
 
-Detect GitHub-style tickets/issues with [Linkify](https://linkify.js.org/).
+[![npm version](https://badge.fury.io/js/linkify-plugin-ticket.svg)](https://www.npmjs.com/package/linkify-plugin-ticket)
+
+Detect and convert GitHub-style issue or ticket numbers (e.g., `#123`) to `<a>` anchor tags with [Linkify](https://linkify.js.org/).
 
 ## Installation
 

diff --git a/packages/linkify-react/README.md b/packages/linkify-react/README.md
@@ -1,7 +1,9 @@
 linkify-react
 ===
 
-[Linkify](https://linkify.js.org/) React component. Walks through its children and replaces strings containing URLs with strings and &lt;a&gt; elements.
+[![npm version](https://badge.fury.io/js/linkify-react.svg)](https://www.npmjs.com/package/linkify-react)
+
+[Linkify](https://linkify.js.org/) React component. Use it to find URLs, email addresses and more in child strings and replace them with strings and &lt;a&gt; elements.
 
 ## Installation
 
@@ -23,6 +25,14 @@ import Linkify from 'linkify-react';
 
 ## Usage
 
+```jsx
+const contents = 'helloworld.com';
+
+<Linkify options={...}>
+  {contents}
+</Linkify>
+```
+
 [Read the full documentation](https://linkify.js.org/docs/linkify-react.html).
 
 ## License

diff --git a/packages/linkify-string/README.md b/packages/linkify-string/README.md
@@ -1,13 +1,15 @@
 linkify-string
 ===
 
-[Linkify](https://linkify.js.org/) String Interface. Use `linkify-string` to replace links in plain-text strings with anchor tags.
+[![npm version](https://badge.fury.io/js/linkify-string.svg)](https://www.npmjs.com/package/linkify-string)
+
+[Linkify](https://linkify.js.org/) String Interface. Use `linkify-string` to detect URLs, email addresses and more in plain-text strings and wrap them with anchor `<a>` tags.
 
 This function will ***not*** parse strings with HTML. Use one of the following instead, depending on your application:
 
-* `linkify-html`
-* `linkify-element`
-* `linkify-jquery`
+* [`linkify-html`](../linkify-html/)
+* [`linkify-element`](../linkify-element/)
+* [`linkify-jquery`](../linkify-jquery/)
 
 
 ## Installation

diff --git a/packages/linkifyjs/README.md b/packages/linkifyjs/README.md
@@ -1,9 +1,10 @@
 linkifyjs
 ===
 
-Core [Linkify](https://linkify.js.org/) JavaScript library. Use Linkify and its
-related packages to find links in plain-text and convert them to HTML &lt;a&gt; tags
+[![npm version](https://badge.fury.io/js/linkifyjs.svg)](https://www.npmjs.com/package/linkifyjs)
 
+Core [Linkify](https://linkify.js.org/) JavaScript library. Use Linkify and its
+related packages to detect URLs, email addresses and more in plain-text strings and convert them to HTML `<a>` anchor tags.
 
 ## Installation