From 0fc1300ae4b23a731a59770ecf2643013af38263 Mon Sep 17 00:00:00 2001 From: Raine Revere Date: Wed, 13 Mar 2019 16:04:10 -0600 Subject: [PATCH] Add methods to README. Fixes #77. --- Readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Readme.md b/Readme.md index 6d4271a..af6b25f 100644 --- a/Readme.md +++ b/Readme.md @@ -41,6 +41,15 @@ These are keys in the options object you can pass to the progress bar along with - `clear` option to clear the bar on completion defaulting to false - `callback` optional function to call when the progress bar completes +### Methods + +These are methods you can call on the progress bar. + +- `tick` tick the progress bar +- `render` render the progress bar +- `update` update the progress bar to an exact percentage +- `interrupt` write a message aboute the progress bar + ### Tokens These are tokens you can use in the format of your progress bar.