Merge branch 'main' into parsers

Cargo.toml

@@ -19,7 +19,7 @@ zung_parsers = { version = "0.1.1", path = "./zung_parsers" }
 
 anyhow = "1.0.89"
 anstyle = "1.0.8"
-clap = { version = "4.5.18", features = ["derive"] }
+clap = { version = "4.5.20", features = ["derive"] }
 
 
 [profile.release]

zung_mini/Cargo.toml

@@ -10,7 +10,7 @@ readme = "README.md"
 keywords = ["projects", "learning", "mini"]
 
 [dependencies]
-clap = { version = "4.5.18", features = ["derive"] }
+clap = { version = "4.5.20", features = ["derive"] }
 indicatif = "0.17"
 colored = "2.1.0"
 rand = "0.8"

zung_mini/README.md

@@ -2,10 +2,18 @@
 
 This Library consists of varouis small rust projects that target different features of rust such as traits, lifetimes, type system etc. Each project is separated out in different modules as listed out in [Table of Contents](#table-of-contents) below.
 
-### _Disclaimer_
+## Zung Family
+
+This library is part of the [zung](https://github.com/ishaan26/zung) family.
+Install the zung binary with `cargo install zung` to try out some of the features of this
+library.
+
+## Disclaimer
 
 _This library is intended for **learning purposes only**. While I will do my best to write the most professional code I can (with my limited coding knowledge), it is not my intention for this library to be used in any production environment._
 
+Ateast not yet...
+
 ## Table of Contents
 
 - [Mini Project 1](#mini-project-1---progbar)
@@ -24,17 +32,22 @@ The [`ProgBar`](https://docs.rs/zung_mini/latest/zung_mini/progbar/index.html) m
 
 ## Features
 
-- **Simple Integration**: Easily add progress bars to any iterator with minimal code changes.
-- **Supports Bounded & Unbounded Iterators**: Progress can be tracked for both finite and infinite iterators.
-- **Customizable Appearance**: Modify the style and delimiters of the progress bar.
-- **Real-time Terminal Display**: Live updates of the progress bar in the terminal as your iterator progresses.
+- Easily add progress bars to any iterator with minimal code changes.
+- Progress can be tracked for both finite and infinite iterators.
+- Modify the style and delimiters of the progress bar.
+- Live updates of the progress bar in the terminal as your iterator progresses.
 
 # Mini Project 2 - Strsplit
 
 **_A custom string splitting utility targeting lifetimes in rust following [Crust of Rust: Lifetime Annotations](https://www.youtube.com/watch?v=rAl-9HwD858)_**
 
 The [`Strsplit`](https://docs.rs/zung_mini/latest/zung_mini/strsplit/index.html) module provides an efficient, iterator-based string splitting utility for Rust. It extends both `String` and `&str` types with a `strsplit` method, allowing users to split strings based on a specified delimiter and iterate over the resulting substrings lazily or collect them all at once. This is particularly useful when you need efficient and flexible string splitting behavior.
 
+## Features
+
+- It splits stuff.
+- Not much more than that.
+
 # Mini Project 3 - Orst
 
 **\_ _Implementation of custom sorting algorithms along with a benchmark following [Crust of Rust: Sorting Algorithms](https://www.youtube.com/watch?v=h4RkCyJyXmM)_**
@@ -46,8 +59,6 @@ The [`Orst`](https://docs.rs/zung_mini/latest/zung_mini/orst/index.html) module
 - It sorts stuff.
 - Easy to use.
 
----
-
 # Usage
 
 See the [docs](https://docs.rs/zung_mini/latest/zung_mini/) for how to use each module of this library.

zung_mini/src/lib.rs

@@ -1,6 +1,4 @@
-//! # Introduction
-//!
-//! Mini rust projects that target specific features of rust
+#![doc = include_str!("../README.md")]
 
 pub mod orst;
 pub mod progbar;