summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mgutz/str/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/mgutz/str/doc.go')
-rw-r--r--vendor/github.com/mgutz/str/doc.go19
1 files changed, 19 insertions, 0 deletions
diff --git a/vendor/github.com/mgutz/str/doc.go b/vendor/github.com/mgutz/str/doc.go
new file mode 100644
index 000000000..f48742a1f
--- /dev/null
+++ b/vendor/github.com/mgutz/str/doc.go
@@ -0,0 +1,19 @@
+// Package str is a comprehensive set of string functions to build more
+// Go awesomeness. Str complements Go's standard packages and does not duplicate
+// functionality found in `strings` or `strconv`.
+//
+// Str is based on plain functions instead of object-based methods,
+// consistent with Go standard string packages.
+//
+// str.Between("<a>foo</a>", "<a>", "</a>") == "foo"
+//
+// Str supports pipelining instead of chaining
+//
+// s := str.Pipe("\nabcdef\n", Clean, BetweenF("a", "f"), ChompLeftF("bc"))
+//
+// User-defined filters can be added to the pipeline by inserting a function
+// or closure that returns a function with this signature
+//
+// func(string) string
+//
+package str