From 3612706b9416da317ef5a618cf143b4411fdeb08 Mon Sep 17 00:00:00 2001 From: Thanga Ganapathy Date: Tue, 9 Apr 2024 22:04:14 +0530 Subject: [PATCH] docs: update readme --- .changeset/small-buttons-poke.md | 5 +++++ README.md | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changeset/small-buttons-poke.md diff --git a/.changeset/small-buttons-poke.md b/.changeset/small-buttons-poke.md new file mode 100644 index 0000000..a174118 --- /dev/null +++ b/.changeset/small-buttons-poke.md @@ -0,0 +1,5 @@ +--- +'@opentf/cli-pbar': patch +--- + +Updated docs. diff --git a/README.md b/README.md index 5a8ca63..728d3d1 100644 --- a/README.md +++ b/README.md @@ -214,15 +214,15 @@ After the method is called, the progress bar starts rendering. ### add(bar: Partial): { update: (bar: Partial) => void } -In `multi-progress` bars, it appends a progress bar to the container and returns an object with a method to update it. +In `multi-progress`, it appends a progress bar to the container and returns an instance. ### update(bar: Partial): void -In updates the current progress bar instance. +It is used to update the current progress bar instance. ### inc(bar: Partial): void -In increments the progress bar value and optionaly updates the other bar props. +It increments the progress bar value and optionaly updates the other bar props. ### stop(msg?: string): void