From d2515366386234b2a3d41dca57a2a083909862e5 Mon Sep 17 00:00:00 2001 From: Jakub Sobon Date: Sun, 24 Feb 2019 00:52:49 -0500 Subject: [PATCH] Updated Termdash API (markdown) --- Termdash-API.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Termdash-API.md b/Termdash-API.md index eb9d932..168230f 100644 --- a/Termdash-API.md +++ b/Termdash-API.md @@ -7,4 +7,12 @@ The [termdash](https://github.com/mum4k/termdash/blob/master/termdash.go) packag - Start and stop the application. - Control screen redraw. - Process runtime errors. -- Subscribe to keyboard an mouse events. \ No newline at end of file +- Subscribe to keyboard an mouse events. + +## Starting and stopping the application + +The simplest way to start Termdash is to use the [Run](https://github.com/mum4k/termdash/blob/c861ecef303ac648f926597f28c9f44994a1ca8b/termdash.go#L91-L103) function: + +```go + +``` \ No newline at end of file