docs: update documentation

Author: Mcdostone

README.md

@@ -3,7 +3,7 @@
 <!--
 <a href="https://github.com/MAIF/yozefu/releases"><img src="https://img.shields.io/github/v/release/MAIF/yozefu?style=flatd&color=f8be75&logo=GitHub"></a>-->
 <a href="https://crates.io/crates/yozefu/"><img src="https://img.shields.io/crates/v/yozefu?logo=Rust"></a>
-<a href="https://www.rust-lang.org/"><img src="https://img.shields.io/badge/MSRV-1.80.1+-lightgray.svg?logo=rust" alt="Minimum supported Rust version: 1.80.1 or plus"/></a>
+<a href="https://www.rust-lang.org/"><img src="https://img.shields.io/badge/MSRV-1.85.0+-lightgray.svg?logo=rust" alt="Minimum supported Rust version: 1.85.0 or plus"/></a>
 <a href="https://github.com/MAIF/yozefu/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Licence"/></a>
 
 

crates/app/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yozefu-app"
-description = "A TUI for browsing kafka topics"
+description = "The Kafka consumer of Yozefu"
 keywords = ["kafka", "consumer", "search", "avro"]
 categories = ["command-line-utilities", "development-tools", "gui"]
 readme = "README.md"

crates/app/README.md

@@ -4,9 +4,7 @@
 [![](https://img.shields.io/crates/v/yozefu-app.svg)](https://crates.io/crates/yozefu-app)
 
 
-This library contains the code for the main kafka consumer and all the logic to filter kafka records based on the user-provided search query.
-
-
+This library contains the code for the kafka consumer and all the logic to filter kafka records based on the user-provided search query for [Yozefu](https://github.com/MAIF/yozefu).
 
 ## Usage
 

crates/bin/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yozefu"
-description = "yozefu is a CLI tool for Apache kafka. It allows you to navigate topics and search Kafka records."
+description = "Yozefu is a CLI tool for Apache kafka. It allows you to navigate topics and search Kafka records."
 keywords = ["kafka", "consumer", "avro", "tui", "ratatui"]
 categories = [
     "command-line-utilities",

crates/command/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yozefu-command"
-description = "Clap commands of yozefu"
+description = "Clap commands of Yozefu"
 keywords = ["argument", "cli", "tui", "parser", "parse"]
 readme = "README.md"
 categories = [

crates/command/README.md

@@ -4,7 +4,7 @@
 [![The crate](https://img.shields.io/crates/v/yozefu-command.svg)](https://crates.io/crates/yozefu-command)
 
 
-This library contains the `clap` commands of [yozefu](https://github.com/MAIF/yozefu):
+This library contains the `clap` commands of [Yozefu](https://github.com/MAIF/yozefu):
  - `configure` to access to the configuration file.
  - `create-filter` to crate a new search filter
  - `import-filter` to import the search filter to the tool.

crates/lib/README.md

@@ -4,7 +4,7 @@
 [![](https://img.shields.io/crates/v/yozefu-lib.svg)](https://crates.io/crates/yozefu-lib)
 
 
-This crate provides the core definitions for [yozefu](https://github.com/MAIF/yozefu).
+This crate provides the core definitions for [Yozefu](https://github.com/MAIF/yozefu).
  - [`KafkaRecord`](./src/kafka/kafka_record.rs), the main structure used everywhere representing a kafka record.
  - Definitions of errors that can occur.
  - Structures and functions to parse and execute search queries.

crates/tui/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "yozefu-tui"
-description = "A TUI for browsing kafka topics"
+description = "library for rendering the TUI of Yozefu"
 keywords = ["kafka", "consumer", "tui", "terminal"]
 readme = "README.md"
 categories = [

crates/wasm-types/README.md

@@ -3,7 +3,7 @@
 [![Build](https://github.com/MAIF/yozefu/actions/workflows/build.yml/badge.svg)](https://github.com/MAIF/yozefu/actions/workflows/build.yml)
 [![](https://img.shields.io/crates/v/yozefu-wasm-types.svg)](https://crates.io/crates/yozefu-wasm-types)
 
-This library provides structures for defining a WebAssembly module for the search engine of [yozefu](https://github.com/MAIF/yozefu). It uses `json` to exchange data from the host to the WebAssembly module.
+This library provides structures for defining a WebAssembly module for the search engine of [Yozefu](https://github.com/MAIF/yozefu). It uses `json` to exchange data from the host to the WebAssembly module.
 
 ## Usage