From 71aca577bc6736c96fadbf845cab28a25c852868 Mon Sep 17 00:00:00 2001 From: Caleb Bassi Date: Wed, 28 Nov 2018 20:12:36 -0800 Subject: [PATCH] Update godoc --- README.md | 2 ++ doc.go | 23 +---------------------- 2 files changed, 3 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e492615..7c01f1f 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ Note that termui is currently undergoing major API changes so be prepared for th ### Hello World ```go +package main + import ui "github.com/gizak/termui" func main() { diff --git a/doc.go b/doc.go index 13924eb..34c752f 100644 --- a/doc.go +++ b/doc.go @@ -3,27 +3,6 @@ // be found in the LICENSE file. /* -Package termui is a library designed for creating command line UI. For more info, goto http://github.com/gizak/termui - -A simplest example: - package main - - import ui "github.com/gizak/termui" - - func main() { - if err:=ui.Init(); err != nil { - panic(err) - } - defer ui.Close() - - g := ui.NewGauge() - g.Percent = 50 - g.Width = 50 - g.BorderLabel = "Gauge" - - ui.Render(g) - - ui.Loop() - } +Package termui is a library for creating terminal user interfaces (TUIs) using widgets. */ package termui