aboutsummaryrefslogtreecommitdiff
path: root/lib/glob/README.md
diff options
context:
space:
mode:
authorTulir Asokan <tulir@maunium.net>2018-05-02 22:30:43 +0300
committerTulir Asokan <tulir@maunium.net>2018-05-02 22:30:57 +0300
commitaec3b8d204dd8b4f9308f536e9b5eefcf966f86e (patch)
treee149182b3b085f55e2e9fe2388164dc5a38f68a3 /lib/glob/README.md
parent85cbd64c5e78c5b8aad46c96afbd67505987dec9 (diff)
Add tests for PushRule.Match and fork glob to make it compatible with the spec
Diffstat (limited to 'lib/glob/README.md')
-rw-r--r--lib/glob/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/lib/glob/README.md b/lib/glob/README.md
new file mode 100644
index 0000000..e2e6c64
--- /dev/null
+++ b/lib/glob/README.md
@@ -0,0 +1,28 @@
+# String globbing in Go
+
+[![GoDoc](https://godoc.org/github.com/zyedidia/glob?status.svg)](http://godoc.org/github.com/zyedidia/glob)
+
+This package adds support for globs in Go.
+
+It simply converts glob expressions to regexps. I try to follow the standard defined [here](http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13).
+
+# Example
+
+```go
+package main
+
+import "github.com/zyedidia/glob"
+
+func main() {
+ glob, err := glob.Compile("{*.go,*.c}")
+ if err != nil {
+ // Error
+ }
+
+ glob.Match([]byte("test.c")) // true
+ glob.Match([]byte("hello.go")) // true
+ glob.Match([]byte("test.d")) // false
+}
+```
+
+You can call all the same functions on a glob that you can call on a regexp.