From 0278568ed80ab5549f1759300adcd8ce36fe0147 Mon Sep 17 00:00:00 2001 From: Caleb Bassi Date: Mon, 4 Feb 2019 20:16:27 -0800 Subject: [PATCH] Update README --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 254317c..c72360d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,16 @@ termui is a cross-platform and fully-customizable terminal dashboard and widget - Event handling for keyboard, mouse and resizing events - 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 ```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 - [BarChart](./_examples/barchart.go)