summaryrefslogtreecommitdiff
path: root/vendor/github.com/renstrom/dedent/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/renstrom/dedent/README.md')
-rw-r--r--vendor/github.com/renstrom/dedent/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/vendor/github.com/renstrom/dedent/README.md b/vendor/github.com/renstrom/dedent/README.md
new file mode 100644
index 000000000..35b5aa134
--- /dev/null
+++ b/vendor/github.com/renstrom/dedent/README.md
@@ -0,0 +1,50 @@
+# Dedent
+
+[![Build Status](https://travis-ci.org/renstrom/dedent.svg?branch=master)](https://travis-ci.org/renstrom/dedent)
+[![Godoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/renstrom/dedent)
+
+Removes common leading whitespace from multiline strings. Inspired by [`textwrap.dedent`](https://docs.python.org/3/library/textwrap.html#textwrap.dedent) in Python.
+
+## Usage / example
+
+Imagine the following snippet that prints a multiline string. You want the indentation to both look nice in the code as well as in the actual output.
+
+```go
+package main
+
+import (
+ "fmt"
+
+ "github.com/renstrom/dedent"
+)
+
+func main() {
+ s := `Lorem ipsum dolor sit amet,
+ consectetur adipiscing elit.
+ Curabitur justo tellus, facilisis nec efficitur dictum,
+ fermentum vitae ligula. Sed eu convallis sapien.`
+ fmt.Println(dedent.Dedent(s))
+ fmt.Println("-------------")
+ fmt.Println(s)
+}
+```
+
+To illustrate the difference, here's the output:
+
+
+```bash
+$ go run main.go
+Lorem ipsum dolor sit amet,
+consectetur adipiscing elit.
+Curabitur justo tellus, facilisis nec efficitur dictum,
+fermentum vitae ligula. Sed eu convallis sapien.
+-------------
+Lorem ipsum dolor sit amet,
+ consectetur adipiscing elit.
+ Curabitur justo tellus, facilisis nec efficitur dictum,
+ fermentum vitae ligula. Sed eu convallis sapien.
+```
+
+## License
+
+MIT