From d877b4e490d1bcf94adca5447eb5bef0509bcdcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ghignatti=20Nicol=C3=B2?= Date: Sat, 11 Oct 2025 22:57:47 +0200 Subject: [PATCH] Update documentation on gh-pages --- docs/changelog.md | 10 ++++++---- docs/commands.md | 11 ++++------- docs/development.md | 9 +++++++++ docs/index.md | 12 ++---------- docs/installation.md | 2 +- docs/usage.md | 4 ++++ 6 files changed, 26 insertions(+), 22 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 079d6be..d58e354 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,12 +1,14 @@ # 🪵 Changelog -This file summarizes the main updates of the project. -For the full history, see [Changes.md](../Changes.md). - --- -## 🧱 Initial Release +## 🧱 Initial Release (v0.1.0 & v0.1.1) - Base CLI created (`add`, `commit`, `push`) - Emoji mapping system introduced - MkDocs documentation scaffolded - GitHub CI workflows added (Rust + Release) + +### v0.1.2 +- Refactor some matches with error propagation +- Update README +- Update docs diff --git a/docs/commands.md b/docs/commands.md index 07950f6..c020ce2 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -17,13 +17,10 @@ Example: ```bash glyphit add src/main.rs ``` - -Internally, it calls: -```rust -git add +Or also: +```bash +glyphit add . ``` -and prepares commit metadata with the correct emoji. - --- ## `glyphit commit` @@ -41,7 +38,7 @@ glyphit commit # => 🐛 fix: memory leak ``` -GlyphIt automatically determines the emoji by scanning the message or type keyword. +All the commit message building process is evolutional and aims to avoid user do errors while building it. --- diff --git a/docs/development.md b/docs/development.md index 399b991..633b543 100644 --- a/docs/development.md +++ b/docs/development.md @@ -34,6 +34,15 @@ cargo test functions::commit --- +## 👍 Good convention + +Before submitting a PR, please make sure to run: +```bash +cargo clippy +``` + +--- + ## 🧰 Contributing 1. Fork the repository diff --git a/docs/index.md b/docs/index.md index 6e4232d..c39ec93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,8 @@ -# GlyphIt +

GlyphIt

**GlyphIt** is a Rust-based CLI tool designed to **standardize and simplify the use of emojis in Git commit messages**. ---- - -## ✨ Features - -- 🚀 **Automatic emoji mapping** for commit types (`add`, `fix`, `docs`, `chore`, etc.) -- 🧩 **Lightweight and fast** — built with Rust -- ⚙️ **Easy integration** into Git workflows -- 🧠 **Extensible** — developers can add new emoji rules or commit templates -- 🗂️ **CLI-based** — no GUI, just straightforward commands +It aims to provide a fast way to structure your commit, according to a conventional standard, without having to wait for long times. --- diff --git a/docs/installation.md b/docs/installation.md index a62b780..fe71c5a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -24,4 +24,4 @@ target/release/glyphit ## 🧠 From release -The download is available in the [release section](https://github.com/NickGhignatti/glyphit/releases) of the github page \ No newline at end of file +The download is available in the [release section](https://github.com/NickGhignatti/glyphit/releases) of the github page, choose your OS version carefully! \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md index 6ad32b7..4e3a445 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -34,3 +34,7 @@ Then it will start an interactive builder for your commit message ``` Each command integrates seamlessly with Git and ensures consistent emoji usage. + +--- + +Glyphit allow users to interpolate normal git functions (like `git add ` or `git push `), but it is not it's main purpose. \ No newline at end of file