From 7c002ed7076fee598fac4c599536db088b87b04d Mon Sep 17 00:00:00 2001 From: Ishaan Goel <46309254+ishaan26@users.noreply.github.com> Date: Tue, 1 Oct 2024 10:48:59 +0530 Subject: [PATCH 1/3] fix: README.md Fixed formatting and doc link. --- zung_mini/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/zung_mini/README.md b/zung_mini/README.md index 1203a11..1c098c7 100644 --- a/zung_mini/README.md +++ b/zung_mini/README.md @@ -1,9 +1,8 @@ Mini rust projects that target specific features of rust -> # Disclaimer - -> This library is intended for **learning purposes only** and is not production-grade. While it demonstrates core functionality for implementing a progress bar in Rust, it may lack the optimizations, testing, and features required for production use. Use at your own risk in critical applications. + ### _Disclaimer_ +_This library is intended for **learning purposes only**_ ## Table of Contents - [Mini Project 1](#mini-project-1---progbar) @@ -24,4 +23,4 @@ Mini rust projects that target specific features of rust ## Usage -See the [docs](https://docs.rs/zung_mini/0.1.2/zung_mini/progbar/index.html) for how to use this library. +See the [docs](https://docs.rs/zung_mini/latest/zung_mini/progbar/index.html) for how to use this library. From ef98cb6b93780e4111501ac9a4faa5b3047777d6 Mon Sep 17 00:00:00 2001 From: Ishaan Goel <46309254+ishaan26@users.noreply.github.com> Date: Tue, 1 Oct 2024 10:57:53 +0530 Subject: [PATCH 2/3] Update README.md --- zung_mini/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/zung_mini/README.md b/zung_mini/README.md index 1c098c7..9f463e8 100644 --- a/zung_mini/README.md +++ b/zung_mini/README.md @@ -1,18 +1,19 @@ -Mini rust projects that target specific features of rust +___Mini rust projects that target specific features of rust___ ### _Disclaimer_ -_This library is intended for **learning purposes only**_ +_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 knowlege), it is not my intention for this library to be used in any production environment._ ## Table of Contents - [Mini Project 1](#mini-project-1---progbar) + - [Features](#features) - [Usage](#usage) # Mini Project 1 - ProgBar > A Simple Progress Bar for Rust Iterators -`ProgBar` is a lightweight and customizable progress bar library for Rust iterators. It allows you to easily track the progress of any iterator in your terminal with visual feedback. Whether your iterator is bounded (has a known size) or unbounded, `ProgBar` adapts to display the progress accordingly. +[`ProgBar`](https://docs.rs/zung_mini/latest/zung_mini/progbar/index.html) module is a lightweight and customizable progress bar library for Rust iterators. It allows you to easily track the progress of any iterator in your terminal with visual feedback. Whether your iterator is bounded (has a known size) or unbounded (infinite loop), `ProgBar` adapts to display the progress accordingly. ## Features From fea178bffdd82329cb4a1357e30015e78ded49b4 Mon Sep 17 00:00:00 2001 From: Ishaan Goel <46309254+ishaan26@users.noreply.github.com> Date: Tue, 1 Oct 2024 12:24:27 +0530 Subject: [PATCH 3/3] Update README.md --- zung_mini/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/zung_mini/README.md b/zung_mini/README.md index 9f463e8..53ba8e4 100644 --- a/zung_mini/README.md +++ b/zung_mini/README.md @@ -1,13 +1,16 @@ -___Mini rust projects that target specific features of rust___ +# Zung Mini - Mini Rust Projects + +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_ _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 knowlege), it is not my intention for this library to be used in any production environment._ + ## Table of Contents - [Mini Project 1](#mini-project-1---progbar) - [Features](#features) - - [Usage](#usage) +- [Usage](#usage) # Mini Project 1 - ProgBar @@ -22,6 +25,6 @@ _This library is intended for **learning purposes only**. While I will do my bes - **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. -## Usage +# Usage -See the [docs](https://docs.rs/zung_mini/latest/zung_mini/progbar/index.html) for how to use this library. +See the [docs](https://docs.rs/zung_mini/latest/zung_mini/progbar/index.html) for how to use each module of this library.