OrgGo
/
termdash
mirror of https://github.com/mum4k/termdash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Termdash API (markdown)

Jakub Sobon 2019-02-24 02:55:32 -05:00
parent 66f08f261c
commit af22c41f0b
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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