summaryrefslogtreecommitdiffstats
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.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/mvdan.cc/xurls/v2/README.md b/vendor/mvdan.cc/xurls/v2/README.md
new file mode 100644
index 0000000000..5058efe7a7
--- /dev/null
+++ b/vendor/mvdan.cc/xurls/v2/README.md
@@ -0,0 +1,28 @@
+# 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.
+
+```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/"}
+}
+```
+
+Note that the funcs compile regexes, so avoid calling them repeatedly.
+
+#### cmd/xurls
+
+ go get -u mvdan.cc/xurls/v2/cmd/xurls
+
+```shell
+$ echo "Do gophers live in http://golang.org?" | xurls
+http://golang.org
+```