From 63cec26e1e83dcacffefdf3aed9e2f9d3ecfd947 Mon Sep 17 00:00:00 2001 From: nxshock Date: Fri, 30 Jul 2021 08:56:34 +0500 Subject: [PATCH] Create README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bbb56e1 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# processmessage + +Go library for displaying progress messages. + +## Usage example + +```go +package main + +import ( + "fmt" + "os" + "time" + + "github.com/nxshock/progressmessage" +) + +func main() { + // Create new message + pm := progressmessage.New("Progress: %d%%...") + + // Start message display + pm.Start() + + // Let's do some job + for i := 0; i < 100; i++ { + // Simulate some work + time.Sleep(time.Second / 5) + + // Update progress variables in same order as specified on creating the message + pm.Update(i + 1) + } + + // Stop message display + pm.Stop() + + // Cursor stays in progress message position so you can display result message manually + fmt.Fprintln(os.Stderr, "\rProcessing finished.") +} +```