From af22c41f0bdc2eb019615250573c1ddd70425e11 Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sun, 24 Feb 2019 02:55:32 -0500 Subject: [PATCH] Updated Termdash API (markdown) --- Termdash-API.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Termdash-API.md b/Termdash-API.md index 88b2ee4..c6ab767 100644 --- a/Termdash-API.md +++ b/Termdash-API.md @@ -9,9 +9,11 @@ The [termdash](https://github.com/mum4k/termdash/blob/master/termdash.go) packag - Process runtime errors. - Subscribe to keyboard and mouse events. -## Starting and stopping the application +The public API surface of this package consists of the following: -The simplest way to start Termdash is to use the [Run](https://github.com/mum4k/termdash/blob/c861ecef303ac648f926597f28c9f44994a1ca8b/termdash.go#L91-L103) function: +## [Run](https://github.com/mum4k/termdash/blob/c861ecef303ac648f926597f28c9f44994a1ca8b/termdash.go#L91-L103) function: + +The **Run** function provides the simplest way to run a Termdash based application. ```go