From 4ec60418d07cf520c8a4c2d825f39055fd2ea346 Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sat, 2 Mar 2019 18:32:27 -0500 Subject: [PATCH] Updated Terminal API (markdown) --- Terminal-API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Terminal-API.md b/Terminal-API.md index 6d5da9e..1e1d076 100644 --- a/Terminal-API.md +++ b/Terminal-API.md @@ -2,15 +2,15 @@ [![Doc Status](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi?status.png)](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi) -The [terminalapi](https://github.com/mum4k/termdash/tree/master/terminal/terminalapi) package exposes types that are common to all terminal implementations. This abstraction was created so that users of Termdash can choose which low-level terminal library they prefer. +The [terminalapi](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi) package exposes types that are common to all terminal implementations. This abstraction was created so that users of Termdash can choose which low-level terminal library they prefer. The public API surface of this package consists of the following: -## [terminalapi.Terminal](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/terminalapi.go#L25-L52) +## [terminalapi.Terminal](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#Terminal) All terminal implementations must implement this interface. -## [terminalapi.ColorMode](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/color_mode.go#L19-L20) +## [terminalapi.ColorMode](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#ColorMode) The **ColorMode** property specifies which colors can be displayed on the terminal and how are they addressed. @@ -21,7 +21,7 @@ Refer to the following pages which provide a list of colors and their numbers: Colors are set as options on terminal cells. Refer to the [[Cell API|cell-api]] for more details. -## [terminalapi.Event](https://github.com/mum4k/termdash/blob/ffbf88caeddb1735dcf2a5f735eec80dc9cf9fe7/terminal/terminalapi/event.go#L28-L31) +## [terminalapi.Event](https://godoc.org/github.com/mum4k/termdash/terminal/terminalapi#Event) This interface represents an input terminal event, which can be one of the following events: