From f8e30bacd31386521eb865a806d3e861eba9acfe Mon Sep 17 00:00:00 2001 From: Caleb Bassi Date: Sat, 23 Feb 2019 16:52:52 -0800 Subject: [PATCH] Update readme --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ed97387..43e2465 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,14 @@ termui is a cross-platform and fully-customizable terminal dashboard and widget - Built in widget implementations for common use cases - Utilities to create custom widgets -- A grid layout for relative widget positioning -- Mouse support -- Event handling for keyboard, mouse and resizing events +- Relative widget positioning using a grid layout +- Event system for keyboard, mouse and terminal 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 +go get -u github.com/gizak/termui ``` ## Hello World @@ -70,7 +65,7 @@ func main() { - [Table](./_examples/table.go) - [Tabs](./_examples/tabs.go) -Run an example with `go run _examples/{example}.go` or run all of them consecutively with `make run-examples`. +Run an example with `go run _examples/{example}.go` or run each example consecutively with `make run-examples`. ## Documentation