From b6d0ec0ee08c7f7af45b91f5066d8fb81df71328 Mon Sep 17 00:00:00 2001 From: Pranav Srinivas Kumar Date: Mon, 16 Dec 2019 09:26:49 -0600 Subject: [PATCH] Updated README --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 704a7b4..7e36f1f 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,38 @@ int main() { } ``` +# Smooth Block Progress Bar + +Are you in need of a smooth block progress bar using [unicode block elements](https://en.wikipedia.org/wiki/Block_Elements)? Use `BlockProgressBar` instead of `ProgressBar`. + +`BlockProgressBar` uses unicode block elements that achieve a smooth progress bar experience + +

+ +

+ +`BlockProgressBar` is slighly less configurable compared to `ProgressBar` but you can still set the prefix text, postfix text, color etc. + +```cpp + indicators::BlockProgressBar bar; + + // Configure the bar + bar.set_bar_width(80); + bar.start_bar_with("["); + bar.end_bar_with("]"); + bar.set_foreground_color(indicators::Color::WHITE); + + // Update bar state + auto progress = 0.0f; + while (true) { + bar.set_progress(progress); + progress += 0.25f; + if (bar.is_completed()) + break; + std::this_thread::sleep_for(std::chrono::milliseconds(50)); + } +``` + # Progress Spinner To introduce a progress spinner in your application, include `indicators/progress_spinner.hpp` and create a `ProgressSpinner` object.