aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/mvdan.cc/xurls/v2/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/mvdan.cc/xurls/v2/README.md')
-rw-r--r--vendor/mvdan.cc/xurls/v2/README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/vendor/mvdan.cc/xurls/v2/README.md b/vendor/mvdan.cc/xurls/v2/README.md
index 5058efe7a7..07fbdb3b25 100644
--- a/vendor/mvdan.cc/xurls/v2/README.md
+++ b/vendor/mvdan.cc/xurls/v2/README.md
@@ -1,18 +1,20 @@
# xurls
[![GoDoc](https://godoc.org/mvdan.cc/xurls?status.svg)](https://godoc.org/mvdan.cc/xurls)
-[![Travis](https://travis-ci.org/mvdan/xurls.svg?branch=master)](https://travis-ci.org/mvdan/xurls)
-Extract urls from text using regular expressions. Requires Go 1.10.3 or later.
+Extract urls from text using regular expressions. Requires Go 1.12 or later.
```go
import "mvdan.cc/xurls/v2"
func main() {
- xurls.Relaxed().FindString("Do gophers live in golang.org?")
- // "golang.org"
- xurls.Strict().FindAllString("foo.com is http://foo.com/.", -1)
- // []string{"http://foo.com/"}
+ rxRelaxed := xurls.Relaxed()
+ rxRelaxed.FindString("Do gophers live in golang.org?") // "golang.org"
+ rxRelaxed.FindString("This string does not have a URL") // ""
+
+ rxStrict := xurls.Strict()
+ rxStrict.FindAllString("must have scheme: http://foo.com/.", -1) // []string{"http://foo.com/"}
+ rxStrict.FindAllString("no scheme, no match: foo.com", -1) // []string{}
}
```
@@ -20,7 +22,9 @@ Note that the funcs compile regexes, so avoid calling them repeatedly.
#### cmd/xurls
- go get -u mvdan.cc/xurls/v2/cmd/xurls
+To install the tool globally:
+
+ go get mvdan.cc/xurls/cmd/xurls
```shell
$ echo "Do gophers live in http://golang.org?" | xurls