diff --git a/Mouse-API.md b/Mouse-API.md index 4ae66d2..83d1d3d 100644 --- a/Mouse-API.md +++ b/Mouse-API.md @@ -2,13 +2,13 @@ [![Doc Status](https://godoc.org/github.com/mum4k/termdash/mouse?status.png)](https://godoc.org/github.com/mum4k/termdash/mouse) -The [mouse](https://github.com/mum4k/termdash/tree/master/mouse) package exposes types that represent mouse buttons. +The [mouse](https://godoc.org/github.com/mum4k/termdash/mouse) package exposes types that represent mouse buttons. This is a data-only package which provides types that are accepted by the infrastructure and widgets in multiple locations. The public API surface of this package consists of the following: -## [mouse.Button](https://github.com/mum4k/termdash/blob/1a7bcf40e818109611d0b8a49b5994085a20b479/mouse/mouse.go#L18-L19) +## [mouse.Button](https://godoc.org/github.com/mum4k/termdash/mouse#Button) The **mouse.Button** type represents mouse buttons. The package provides predefined values for the recognised mouse buttons.