Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -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
11 changes: 4 additions & 7 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,10 @@ Example:
```bash
glyphit add src/main.rs
```

Internally, it calls:
```rust
git add <files>
Or also:
```bash
glyphit add .
```
and prepares commit metadata with the correct emoji.

---

## `glyphit commit`
Expand All @@ -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.

---

Expand Down
9 changes: 9 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 2 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
# GlyphIt
<h1 align="center">GlyphIt</h1>

**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.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
The download is available in the [release section](https://github.com/NickGhignatti/glyphit/releases) of the github page, choose your OS version carefully!
4 changes: 4 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.