summaryrefslogtreecommitdiff
path: root/vendor/mvdan.cc/xurls/v2/README.md
diff options
context:
space:
mode:
authorLibravatar Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>2021-08-12 21:03:24 +0200
committerLibravatar GitHub <noreply@github.com>2021-08-12 21:03:24 +0200
commit98263a7de64269898a2f81207e38943b5c8e8653 (patch)
tree743c90f109a6c5d27832d1dcef2388d939f0f77a /vendor/mvdan.cc/xurls/v2/README.md
parentText duplication fix (#137) (diff)
downloadgotosocial-98263a7de64269898a2f81207e38943b5c8e8653.tar.xz
Grand test fixup (#138)
* start fixing up tests * fix up tests + automate with drone * fiddle with linting * messing about with drone.yml * some more fiddling * hmmm * add cache * add vendor directory * verbose * ci updates * update some little things * update sig
Diffstat (limited to 'vendor/mvdan.cc/xurls/v2/README.md')
-rw-r--r--vendor/mvdan.cc/xurls/v2/README.md37
1 files changed, 37 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 000000000..67f721ede
--- /dev/null
+++ b/vendor/mvdan.cc/xurls/v2/README.md
@@ -0,0 +1,37 @@
+# xurls
+
+[![Go Reference](https://pkg.go.dev/badge/mvdan.cc/xurls/v2.svg)](https://pkg.go.dev/mvdan.cc/xurls/v2)
+
+Extract urls from text using regular expressions. Requires Go 1.15 or later.
+
+```go
+import "mvdan.cc/xurls/v2"
+
+func main() {
+ 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{}
+}
+```
+
+Since API is centered around [regexp.Regexp](https://golang.org/pkg/regexp/#Regexp),
+many other methods are available, such as finding the [byte indexes](https://golang.org/pkg/regexp/#Regexp.FindAllIndex)
+for all matches.
+
+Note that calling the exposed functions means compiling a regular expression, so
+repeated calls should be avoided.
+
+#### cmd/xurls
+
+To install the tool globally:
+
+ cd $(mktemp -d); go mod init tmp; GO111MODULE=on go get mvdan.cc/xurls/v2/cmd/xurls
+
+```shell
+$ echo "Do gophers live in http://golang.org?" | xurls
+http://golang.org
+```