Skip to content

Commit 71cdd12

Browse files
authored
v2.0.0 release
1 parent b51eaf2 commit 71cdd12

File tree

9 files changed

+552
-212
lines changed

9 files changed

+552
-212
lines changed

.github/workflows/go.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
- name: Set up Go 1.x
1717
uses: actions/setup-go@v2
1818
with:
19-
go-version: ^1.13
19+
go-version: ^1.15
2020
id: go
2121

2222
- name: Check out code into the Go module directory
@@ -31,7 +31,7 @@ jobs:
3131
fi
3232
3333
- name: Build
34-
run: go build -v .
34+
run: go build -o box
3535

3636
- name: Test
3737
run: go test -v .

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
# Box CLI Maker 📦
1+
<div align="center">
2+
<h1>Box CLI Maker 📦 </h1>
3+
</div>
24

5+
<p align="center">
6+
Box CLI Maker is a Highly Customized Terminal Box Creator.
7+
</p>
8+
9+
<div align="center">
310

411
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/Delta456/box-cli-maker)
512
[![CI](https://github.com/Delta456/box-cli-maker/workflows/Box%20CLI%20Maker/badge.svg)](https://github.com/Delta456/box-cli-maker/actions?query=workflow%3A"Box+CLI+Maker")
613
[![Go Report Card](https://goreportcard.com/badge/github.com/Delta456/box-cli-maker)](https://goreportcard.com/report/github.com/Delta456/box-cli-maker)
714
[![GolangCI](https://golangci.com/badges/github.com/moul/golang-repo-template.svg)](https://golangci.com/r/github.com/Delta456/box-cli-maker)
815
[![GitHub release](https://img.shields.io/github/release/Delta456/box-cli-maker.svg)](https://github.com/Delta456/box-cli-maker/releases)
916

10-
11-
Box CLI Maker is a Highly Customized Terminal Box Creator.
17+
</div>
1218

1319
## Features
1420

15-
- Make Terminal Box in 8️⃣ inbuilt different style
16-
- Color Support 🎨
21+
- Make Terminal Box in 8️⃣ inbuilt different styles
22+
- 16 Inbuilt Colors and Custom (24 bit) Colors Support 🎨
1723
- Custom Title Positions
1824
- Make your own Terminal Box style 📦
1925
- Align the text according to the need
20-
- Unicode and Emoji Support 😋
26+
- Unicode, Emoji and [Windows Console](https://en.wikipedia.org/wiki/Windows_Console) Support 😋
2127
- Written in 🇬 🇴
2228

2329
## Installation
@@ -132,7 +138,7 @@ type Box struct {
132138
BottomRight string // BottomRight corner used for Symbols
133139
BottomLeft string // BotromLeft corner used for Symbols
134140
Horizontal string // Symbols used for Horizontal Bars
135-
Con Config // Configuration for the Box to be made
141+
Config // Configuration for the Box to be made
136142
}
137143
```
138144

@@ -182,6 +188,12 @@ var fgHiColors = map[string]color.Attribute{
182188

183189
If you want High Intensity Colors then the Color name should start with `Hi`. If Color option is empty or invalid then Box with default Color is formed.
184190

191+
It can even have custom color which can be provided in `[3]uint` and `uint` though the elements of the array must be in a range of `[0x0, 0xFF]` and `uint` must be in a range of `[0x000000, 0xFFFFFF]`.
192+
193+
If you want to use the string representation of the `Box` and print them for [`Windows Console`](https://en.wikipedia.org/wiki/Windows_Console) then you would have to use `box.Output` as the passing stream to the respective functions.
194+
195+
`Windows Console` is 4 bit (16 colors) so Custom Colors will not work for them but the `Box` will be printed correctly without the Color effect.
196+
185197
### Note
186198

187199
#### Vertical Alignment
@@ -203,9 +215,9 @@ I thank the following people and their packages whom I have studied and was able
203215

204216
- [thecodrr/boxx](https://github.com/thecodrr/boxx)
205217
- [Atrox/box](https://github.com/Atrox/box)
206-
- [sindreorhus-cli-boxs](https://github.com/sindresorhus/cli-boxes)
218+
- [sindreorhus-cli-boxes](https://github.com/sindresorhus/cli-boxes)
207219

208-
Special thanks to [@elimsteve](https://github.com/elimisteve) who helped me to optimize and tell me the best ways possible to fix my problems.
220+
Special thanks to [@elimsteve](https://github.com/elimisteve) who helped me to optimize the code and told me the best possible ways to fix my problems and [@JalonSolov](https://github.com/JalonSolov) for tab lines support.
209221

210222
Kudos to [moul/golang-repo-template](https://github.com/moul/golang-repo-template) for their Go template.
211223

0 commit comments

Comments
 (0)