From 894173ad41095b216f6faabb161022ba5c072cf6 Mon Sep 17 00:00:00 2001 From: 00JCIV00 Date: Wed, 23 Oct 2024 11:18:38 -0400 Subject: [PATCH] Updated the README for the 'logger' example - Changed the 'log_enum' example filename to 'logger'. - Changed the internal Command. - Updated relevant links. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c1012e5..b10bb48 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Cova is based on the idea that Arguments will fall into one of three types: Comm - [API Docs](https://00jciv00.github.io/cova/) ### Quick Example -[Log Enum Example](https://github.com/00JCIV00/cova/blob/main/examples/log-enum.zig) +[Logger Example](https://github.com/00JCIV00/cova/blob/main/examples/logger.zig) ```shell logger --log-level info ``` @@ -30,8 +30,9 @@ logger --log-level info // ... pub const CommandT = cova.Command.Custom(.{...}); pub const setup_cmd = CommandT{ - .name = "log_enum", + .name = "logger", .description = "A small demo of using the Log Level Enum as an Option.", + .examples = &.{ "logger --log-level info" }, .opts = &.{ .{ .name = "log_level", @@ -230,7 +231,7 @@ pub fn main() !void { ### More Examples -- [log-enum](./examples/log-enum.zig): The simple example from the top of the README. +- [logger](./examples/logger.zig): The simple example from the top of the README. - [basic-app](./examples/basic_app.zig): Where the above examples come from. - [covademo](./examples/covademo.zig): This is the testbed for Cova, but its a good demo of virtually every feature in the library.