From 0802d19a2d4e042327443b0335d6e206aa597b1e Mon Sep 17 00:00:00 2001 From: gregfenton Date: Sun, 23 May 2021 16:40:38 -0400 Subject: [PATCH] README updates for `phone` and `url` Tweaks to documentation based on responses to #56 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a00406..d234bc0 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,7 @@ See the [Custom Matchers](#custom-matchers) section below for more information. | Type | Required | Default | Description | | ----------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| boolean or string | No | `true` | Whether to link phone numbers. Possible values: `false` (disabled), `true` (`tel:{number}`), `"sms"` or `"text"` (`sms:{number}`). | +| boolean or string | No | `true` | Whether to link phone numbers. Possible values: `false` (disabled), `true` (creates the hyperlink `tel:{number}`), `"sms"` or `"text"` (creates the hyperlink `sms:{number}`). | _Note:_ Currently, only US numbers are supported. @@ -319,6 +319,8 @@ type UrlConfig = { }; ``` +Setting `url={true}` is equivalent to `url={schemeMatches: true, wwwMatches: true, tldMatches: true}`. + ```js