From 883a534b32e46adc5d3067f0db8d4e7cfe7e8763 Mon Sep 17 00:00:00 2001 From: Kalle Carlbark Date: Fri, 7 Jun 2024 23:15:58 +0200 Subject: [PATCH] docs: Update README --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c2b847..077b2d0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ # zpinner -Nice zpinner in the terminal made in zig. \ No newline at end of file +Nice zpinner in the terminal made in zig. + +## Usage +```zig +const std = @import("std"); +const zpinner = @import("zpinner.zig"); + +pub fn main() !void { + const stdout_file = std.io.getStdOut().writer(); + var zpin = zpinner.new(stdout_file.any(), .{}); + zpin.set_indicator(zpinner.Moon); + zpin.set_suffix(" calculating route to the moon"); + try zpin.start(); + std.time.sleep(5 * std.time.ns_per_s); + try zpin.stop(); + zpin.set_suffix(" counting snakes"); + zpin.set_indicator(zpinner.Snake); + try zpin.start(); + std.time.sleep(5 * std.time.ns_per_s); + zpin.set_indicator(zpinner.Earth); + zpin.set_suffix(" calculating route back to earth"); + std.time.sleep(5 * std.time.ns_per_s); + try zpin.stop(); + zpin.set_suffix(" calculating next week weather"); + zpin.set_indicator(zpinner.Weather); + try zpin.start(); + std.time.sleep(5 * std.time.ns_per_s); + try zpin.stop(); + zpin.set_suffix(" ZzZzz..."); + zpin.set_indicator(zpinner.Clock); + try zpin.start(); + std.time.sleep(5 * std.time.ns_per_s); + try zpin.stop(); + + try stdout_file.print("work done\n", .{}); +} +``` + +