From e55367083667eb0821848a74d2febde70ee69ca7 Mon Sep 17 00:00:00 2001 From: xdrm-brackets Date: Sun, 27 Jan 2019 17:04:45 +0100 Subject: [PATCH] update readme: add hyperlink format --- README.md | 51 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 35 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 332e5bf..ee2b7b5 100644 --- a/README.md +++ b/README.md @@ -11,23 +11,25 @@ Simple utility written in `go` that extends the standard `fmt.Sprintf` and `fmt. - [(1) Format](#1-format) - - [[Colorization]](#colorization) - - [Base format](#base-format) - - [Example](#example) - - [Foreground only](#foreground-only) - - [Example](#example-1) - - [Background only](#background-only) - - [Example](#example-2) - - [[Markdown-like format]](#markdown-like-format) - - [Bold format](#bold-format) - - [Example](#example-3) - - [Italic format](#italic-format) - - [Example](#example-4) - - [Underline format](#underline-format) - - [Example](#example-5) + * [[Colorization]](#colorization) + + [Base format](#base-format) + * [Example](#example) + + [Foreground only](#foreground-only) + * [Example](#example-1) + + [Background only](#background-only) + * [Example](#example-2) + * [[Markdown-like format]](#markdown-like-format) + + [Bold format](#bold-format) + * [Example](#example-3) + + [Italic format](#italic-format) + * [Example](#example-4) + + [Underline format](#underline-format) + * [Example](#example-5) + + [Hyperlink format](#hyperlink-format) + * [Example](#example-6) - [(2) Screenshot](#2-screenshot) - - [Colorizing format example :](#colorizing-format-example-) - - [Markdown-like format example](#markdown-like-format-example) + * [Colorizing format example :](#colorizing-format-example-) + * [Markdown-like format example](#markdown-like-format-example) - [(3) Incoming features](#3-incoming-features) @@ -156,6 +158,23 @@ clifmt.Printf("normal text _underline text_ normal text") +#### Hyperlink format + +```go +[]() +``` + +- `` is the text that will be displayed. +- `` is the url the hyperlink links to. + +###### Example + +```go +clifmt.Printf("normal text [hyper](link) normal text") +``` + + + ---- ## (2) Screenshot