aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/MichaelMure/go-term-text/Readme.md
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2020-02-05 22:03:19 +0100
committerMichael Muré <batolettre@gmail.com>2020-02-05 22:33:03 +0100
commit1d4bb7ceb0cef79d68df0bacc913b01e40e6ddd6 (patch)
treee088b0fa43058afde1db71541d8fcb4b94905d6e /vendor/github.com/MichaelMure/go-term-text/Readme.md
parentf093be96e98284580d61664adecd0a2ff8b354e4 (diff)
downloadgit-bug-1d4bb7ceb0cef79d68df0bacc913b01e40e6ddd6.tar.gz
migrate to go modules
Diffstat (limited to 'vendor/github.com/MichaelMure/go-term-text/Readme.md')
-rw-r--r--vendor/github.com/MichaelMure/go-term-text/Readme.md74
1 files changed, 0 insertions, 74 deletions
diff --git a/vendor/github.com/MichaelMure/go-term-text/Readme.md b/vendor/github.com/MichaelMure/go-term-text/Readme.md
deleted file mode 100644
index 25722ee9..00000000
--- a/vendor/github.com/MichaelMure/go-term-text/Readme.md
+++ /dev/null
@@ -1,74 +0,0 @@
-# go-term-text
-
-[![Build Status](https://travis-ci.org/MichaelMure/go-term-text.svg?branch=master)](https://travis-ci.org/MichaelMure/go-term-text)
-[![GoDoc](https://godoc.org/github.com/MichaelMure/go-term-text?status.svg)](https://godoc.org/github.com/MichaelMure/go-term-text)
-[![Go Report Card](https://goreportcard.com/badge/github.com/MichaelMure/go-term-text)](https://goreportcard.com/report/github.com/MichaelMure/go-term-text)
-[![codecov](https://codecov.io/gh/MichaelMure/go-term-text/branch/master/graph/badge.svg)](https://codecov.io/gh/MichaelMure/go-term-text)
-[![GitHub license](https://img.shields.io/github/license/MichaelMure/go-term-text.svg)](https://github.com/MichaelMure/go-term-text/blob/master/LICENSE)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/the-git-bug/Lobby)
-
-`go-term-text` is a go package implementing a collection of algorithms to help format and manipulate text for the terminal.
-
-In particular, `go-term-text`:
-- support wide characters (chinese, japanese ...) and emoji
-- handle properly ANSI escape sequences
-
-Included algorithms cover:
-- wrapping with padding and indentation
-- padding
-- text length
-- trimming
-- alignment
-- escape sequence extraction and reapplication
-- escape sequence snapshot and simplification
-- truncation
-
-## Example
-
-```go
-package main
-
-import (
- "fmt"
- "strings"
-
- "github.com/MichaelMure/go-term-text"
-)
-
-func main() {
- input := "The \x1b[1mLorem ipsum\x1b[0m text is typically composed of " +
- "pseudo-Latin words. It is commonly used as \x1b[3mplaceholder\x1b[0m" +
- " text to examine or demonstrate the \x1b[9mvisual effects\x1b[0m of " +
- "various graphic design. 一只 A Quick \x1b[31m敏捷的狐 Fox " +
- "狸跳过了\x1b[0mDog一只懒狗。"
-
- output, n := text.Wrap(input, 60,
- text.WrapIndent("\x1b[34m<-indent-> \x1b[0m"),
- text.WrapPad("\x1b[33m<-pad-> \x1b[0m"),
- )
-
- fmt.Printf("output has %d lines\n\n", n)
-
- fmt.Println("|" + strings.Repeat("-", 58) + "|")
- fmt.Println(output)
- fmt.Println("|" + strings.Repeat("-", 58) + "|")
-}
-```
-
-This will print:
-
-![example output](/img/example.png)
-
-For more details, have a look at the [GoDoc](https://godoc.org/github.com/MichaelMure/go-term-text).
-
-## Origin
-
-This package has been extracted from the [git-bug](https://github.com/MichaelMure/git-bug) project. As such, its aim is to support this project and not to provide an all-in-one solution. Contributions as welcome though.
-
-## Contribute
-
-PRs accepted.
-
-## License
-
-MIT