From fb9127f0d576d2771b7b01ae22235e18282539a0 Mon Sep 17 00:00:00 2001
From: Noah Petherbridge <root@kirsle.net>
Date: Mon, 9 Mar 2020 17:29:17 -0700
Subject: [PATCH] Add version number and documentation

---
 docs.go         | 10 ++++++++++
 go.mod          |  6 +-----
 tooltip_test.go | 30 ++++++++++++++++++++++++++++++
 version.go      |  4 ++++
 4 files changed, 45 insertions(+), 5 deletions(-)
 create mode 100644 docs.go
 create mode 100644 tooltip_test.go
 create mode 100644 version.go

diff --git a/docs.go b/docs.go
new file mode 100644
index 0000000..a6fd136
--- /dev/null
+++ b/docs.go
@@ -0,0 +1,10 @@
+/*
+Package ui provides a user interface toolkit for Go.
+
+The UI toolkit targets SDL2 applications on desktop (Linux, Mac and Windows)
+or an HTML Canvas render engine for web browsers.
+
+It provides various widgets such as Frame, Label, Button, Checkbox, Radiobox
+and Tooltip and an event supervisor to monitor the state of the widgets.
+*/
+package ui
diff --git a/go.mod b/go.mod
index 630c5e6..fbd0de0 100644
--- a/go.mod
+++ b/go.mod
@@ -2,8 +2,4 @@ module git.kirsle.net/go/ui
 
 go 1.13
 
-require (
-	git.kirsle.net/go/render v0.0.0-20200102014411-4d008b5c468d
-	github.com/veandco/go-sdl2 v0.4.1 // indirect
-	golang.org/x/image v0.0.0-20200119044424-58c23975cae1 // indirect
-)
+require git.kirsle.net/go/render v0.0.0-20200102014411-4d008b5c468d
diff --git a/tooltip_test.go b/tooltip_test.go
new file mode 100644
index 0000000..2f47fad
--- /dev/null
+++ b/tooltip_test.go
@@ -0,0 +1,30 @@
+package ui_test
+
+import "git.kirsle.net/go/ui"
+
+// Tooltip usage example.
+func ExampleTooltip() {
+	mw, err := ui.NewMainWindow("Tooltip Example", 800, 600)
+	if err != nil {
+		panic(err)
+	}
+
+	// Add a widget that will have a tooltip attached, i.e. a button.
+	btn := ui.NewButton("My Button", ui.NewLabel(ui.Label{
+		Text: "Hello world!",
+	}))
+	mw.Place(btn, ui.Place{
+		Center: true,
+		Middle: true,
+	})
+
+	// Add a tooltip to it. The tooltip attaches itself to the button's
+	// MouseOver, MouseOut, Compute and Present handlers -- you don't need to
+	// place the tooltip inside the window or parent frame.
+	ui.NewTooltip(btn, ui.Tooltip{
+		Text: "This is a tooltip that pops up\non mouse hover!",
+		Edge: ui.Right,
+	})
+
+	mw.MainLoop()
+}
diff --git a/version.go b/version.go
new file mode 100644
index 0000000..3049f36
--- /dev/null
+++ b/version.go
@@ -0,0 +1,4 @@
+package ui
+
+// Version of the UI toolkit.
+const Version = "0.1.0"