OrgGo
/
termui
mirror of https://github.com/gizak/termui.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README

This commit is contained in:
Caleb Bassi 2019-02-04 20:16:27 -08:00
parent 5ece2b7178
commit 0278568ed8
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -13,6 +13,16 @@ termui is a cross-platform and fully-customizable terminal dashboard and widget
- Event handling for keyboard, mouse and resizing events - Event handling for keyboard, mouse and resizing events
- Colors and styling - Colors and styling
## Installation
Installing from the master branch is recommended since termui has been completely reworked since the latest release and because the latest release doesn't support Go modules.
Do note that termui is still undergoing breaking changes so make sure to check the changelog when upgrading.
```bash
go get -u github.com/gizak/termui@master
```
## Hello World ## Hello World
```go ```go
@ -45,17 +55,6 @@ func main() {
} }
``` ```
## Installation
Installing from the master branch is recommended. termui has been completely reworked since the latest release, and the latest release also doesn't support Go modules.
```bash
go get -u github.com/gizak/termui@master
```
**Note**: termui is currently undergoing API changes so make sure to check the changelog when upgrading.
If you upgrade and notice something is missing or don't like a change, revert the upgrade and open an issue.
## Widgets ## Widgets
- [BarChart](./_examples/barchart.go) - [BarChart](./_examples/barchart.go)