chore: add more docs for detect color level on readme

Author: inhere

README.md

@@ -456,10 +456,9 @@ rgb.Println("rgb color")
 rgb.C256().Println("256 color")
 ```
 
-### Convert utils:
+### Convert utils
 
-- `HexToRgb(hex string) (rgb []int)` Convert hex color string to RGB numbers
-- `RgbToHex(rgb []int) string` Convert RGB to hex code
+`color` has many built-in color conversion utility functions.
 
 ```go
 func Basic2hex(val uint8) string
@@ -513,6 +512,29 @@ There are some useful functions reference
 
 > More useful func please see https://pkg.go.dev/github.com/gookit/color
 
+### Detect color level
+
+`color` automatically checks the color levels supported by the current environment.
+
+```go
+// Level is the color level supported by a terminal.
+type Level = terminfo.ColorLevel
+
+// terminal color available level alias of the terminfo.ColorLevel*
+const (
+	LevelNo  = terminfo.ColorLevelNone     // not support color.
+	Level16  = terminfo.ColorLevelBasic    // basic - 3/4 bit color supported
+	Level256 = terminfo.ColorLevelHundreds // hundreds - 8-bit color supported
+	LevelRgb = terminfo.ColorLevelMillions // millions - (24 bit)true color supported
+)
+```
+
+- `func SupportColor() bool` Whether the current environment supports color output
+- `func Support256Color() bool` Whether the current environment supports 256-color output
+- `func SupportTrueColor() bool` Whether the current environment supports (RGB)True-color output
+- `func TermColorLevel() Level` Get the currently supported color level
+
+
 ## Projects using color
 
 Check out these projects, which use https://github.com/gookit/color :

README.zh-CN.md

@@ -469,29 +469,83 @@ rgb.Println("rgb color")
 rgb.C256().Println("256 color")
 ```
 
-**更多转换方法转换为 `RGBColor`**:
+### 颜色转换方法
+
+`color` 内置了许多颜色转换工具方法
+
+```go
+func Basic2hex(val uint8) string
+
+func Bg2Fg(val uint8) uint8
+func Fg2Bg(val uint8) uint8
+
+func C256ToRgb(val uint8) (rgb []uint8)
+func C256ToRgbV1(val uint8) (rgb []uint8)
+
+func Hex2basic(hex string, asBg ...bool) uint8
+func Hex2rgb(hex string) []int
+func HexToRGB(hex string) []int
+func HexToRgb(hex string) (rgb []int)
+
+func HslIntToRgb(h, s, l int) (rgb []uint8)
+func HslToRgb(h, s, l float64) (rgb []uint8)
+func HsvToRgb(h, s, v int) (rgb []uint8)
+
+func Rgb2ansi(r, g, b uint8, isBg bool) uint8
+func Rgb2basic(r, g, b uint8, isBg bool) uint8
+func Rgb2hex(rgb []int) string
+func Rgb2short(r, g, b uint8) uint8
+func RgbTo256(r, g, b uint8) uint8
+func RgbTo256Table() map[string]uint8
+func RgbToAnsi(r, g, b uint8, isBg bool) uint8
+func RgbToHex(rgb []int) string
+func RgbToHsl(r, g, b uint8) []float64
+func RgbToHslInt(r, g, b uint8) []int
+```
+
+**转换为 `RGBColor`**:
 
 - `func RGBFromSlice(rgb []uint8, isBg ...bool) RGBColor`
 - `func RGBFromString(rgb string, isBg ...bool) RGBColor`
 - `func HEX(hex string, isBg ...bool) RGBColor`
 - `func HSL(h, s, l float64, isBg ...bool) RGBColor`
 - `func HSLInt(h, s, l int, isBg ...bool) RGBColor`
 
-## 方法参考
+## 工具方法参考
 
 一些有用的工具方法参考
 
-- `Disable()` disable color render
-- `SetOutput(io.Writer)` custom set the colored text output writer
-- `ForceOpenColor()` force open color render
+- `Disable()` 禁用颜色渲染输出
+- `SetOutput(io.Writer)` 自定义设置渲染后的彩色文本输出位置
+- `ForceOpenColor()` 强制开启颜色渲染
 - `ClearCode(str string) string` Use for clear color codes
 - `Colors2code(colors ...Color) string` Convert colors to code. return like "32;45;3"
 - `ClearTag(s string) string` clear all color html-tag for a string
 - `IsConsole(w io.Writer)` Determine whether w is one of stderr, stdout, stdin
-- `HexToRgb(hex string) (rgb []int)` Convert hex color string to RGB numbers
-- `RgbToHex(rgb []int) string` Convert RGB to hex code
 - 更多请查看文档 https://pkg.go.dev/github.com/gookit/color
 
+### 检测支持的颜色级别
+
+`color` 会自动检查当前环境支持的颜色级别
+
+```go
+// Level is the color level supported by a terminal.
+type Level = terminfo.ColorLevel
+
+// terminal color available level alias of the terminfo.ColorLevel*
+const (
+	LevelNo  = terminfo.ColorLevelNone     // not support color.
+	Level16  = terminfo.ColorLevelBasic    // basic - 3/4 bit color supported
+	Level256 = terminfo.ColorLevelHundreds // hundreds - 8-bit color supported
+	LevelRgb = terminfo.ColorLevelMillions // millions - (24 bit)true color supported
+)
+```
+
+- `func SupportColor() bool` 当前环境是否支持色彩输出
+- `func Support256Color() bool` 当前环境是否支持256色彩输出
+- `func SupportTrueColor() bool` 当前环境是否支持(RGB)True色彩输出
+- `func TermColorLevel() Level` 获取当前支持的颜色级别
+
 ## 使用Color的项目
 
 看看这些使用了 https://github.com/gookit/color 的项目:

color.go

@@ -69,12 +69,12 @@ var (
 	// supportColor = IsSupportColor()
 )
 
-// TermColorLevel value on current ENV
+// TermColorLevel Get the currently supported color level
 func TermColorLevel() Level {
 	return colorLevel
 }
 
-// SupportColor on the current ENV
+// SupportColor Whether the current environment supports color output
 func SupportColor() bool {
 	return colorLevel > terminfo.ColorLevelNone
 }
@@ -84,12 +84,12 @@ func SupportColor() bool {
 // 	return colorLevel > terminfo.ColorLevelNone
 // }
 
-// Support256Color on the current ENV
+// Support256Color Whether the current environment supports 256-color output
 func Support256Color() bool {
 	return colorLevel > terminfo.ColorLevelBasic
 }
 
-// SupportTrueColor on the current ENV
+// SupportTrueColor Whether the current environment supports (RGB)True-color output
 func SupportTrueColor() bool {
 	return colorLevel > terminfo.ColorLevelHundreds
 }
@@ -98,7 +98,7 @@ func SupportTrueColor() bool {
  * global settings
  *************************************************************/
 
-// Set set console color attributes
+// Set console color attributes
 func Set(colors ...Color) (int, error) {
 	code := Colors2code(colors...)
 	err := SetTerminal(code)
@@ -200,18 +200,17 @@ func RenderCode(code string, args ...interface{}) string {
 // RenderWithSpaces Render code with spaces.
 // If the number of args is > 1, a space will be added between the args
 func RenderWithSpaces(code string, args ...interface{}) string {
-	message := formatArgsForPrintln(args)
+	msg := formatArgsForPrintln(args)
 	if len(code) == 0 {
-		return message
+		return msg
 	}
 
 	// disabled OR not support color
 	if !Enable || !SupportColor() {
-		return ClearCode(message)
+		return ClearCode(msg)
 	}
 
-	// return fmt.Sprintf(FullColorTpl, code, message)
-	return StartSet + code + "m" + message + ResetSet
+	return StartSet + code + "m" + msg + ResetSet
 }
 
 // RenderString render a string with color code.
@@ -234,7 +233,8 @@ func RenderString(code string, str string) string {
 
 // ClearCode clear color codes.
 //
-// eg: "\033[36;1mText\x1b[0m" -> "Text"
+// eg:
+// 	"\033[36;1mText\x1b[0m" -> "Text"
 func ClearCode(str string) string {
 	return codeRegex.ReplaceAllString(str, "")
 }