From c4b5c91db36b494cb9faef0088423e3166b6f1f6 Mon Sep 17 00:00:00 2001
From: Samuel Chai <samuel.chai.development@gmail.com>
Date: Mon, 21 Apr 2025 10:37:40 -0400
Subject: [PATCH] #minor: updating README

---
 README.md | 113 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 112 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f25a7ba..7e8de01 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,114 @@
 # gh-commit
-A gh extension for committing files using the Github API. Useful for committing files in CI.
+
+> **A fast, GitHub-native CLI tool to commit files using the GitHub API.**
+
+---
+
+## ✨ Overview
+
+`gh-commit` is a GitHub CLI extension that allows you to commit changes directly to your repositories using the GitHub API. It is ideal for use in ephemeral environments, CI workflows, or anywhere you want fast, authenticated commits without a local Git identity.
+
+Supports both direct commits and pull request-based workflows.
+
+---
+
+## 🚀 Features
+
+- 📂 Commit selected files or all changes
+- 📎 Create commits using the GitHub API (signed in CI)
+- 🌟 Automatically create branches and PRs
+- 🔍 Smart file detection (staged, tracked, untracked)
+- ✨ Fully styled CLI output with colorized logging
+
+---
+
+## 💡 Usage
+
+```bash
+gh commit [files...] -B <branch> -m <message> [flags]
+```
+
+### Example
+
+Commit all changes:
+```bash
+gh-commit -B main -A -m "fix: update configs"
+```
+
+Create a PR from a new branch:
+```bash
+gh-commit -B main -A -P -T "Update Configs" -D "This PR updates the configs." -l feature -l ci
+```
+
+Dry run (shows what would be committed):
+```bash
+gh-commit -B main -A -d
+```
+
+---
+
+## 🔧 Flags
+
+| Short | Long           | Type         | Description                                                                 |
+|-------|----------------|--------------|-----------------------------------------------------------------------------|
+| -B    | --branch       | `string`     | Target branch (base for PRs or direct commit target) **(required)**        |
+| -m    | --message      | `string`     | Commit message (and PR title if applicable) **(required)**                |
+| -P    | --use-pr       | `bool`       | Create a pull request instead of committing directly                       |
+| -H    | --head-ref     | `string`     | PR head branch name (auto-generated if omitted)                            |
+| -T    | --title        | `string`     | Pull request title (defaults to commit message)                            |
+| -D    | --pr-description | `string`   | Pull request body (defaults to commit message)                             |
+| -l    | --label        | `stringSlice`| Add one or more labels to the pull request                                 |
+| -A    | --all          | `bool`       | Include all tracked files with changes                                     |
+| -U    | --untracked    | `bool`       | Include untracked files (requires `--all`)                                 |
+| -d    | --dry-run      | `bool`       | Show which files would be committed, without committing                    |
+| -V    | --version      | `bool`       | Show version                                                               |
+| -h    | --help         | `bool`       | Show help text                                                             |
+
+---
+
+## 📆 GitHub Actions
+
+```yaml
+- name: Commit and Push Changes
+  run: |
+    gh-commit -B main -A -m "ci: auto-commit"
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Signed commits are automatically created when using GitHub Actions.
+
+---
+
+## 📂 Project Structure
+
+- `cmd/`
+    - CLI definitions and flag parsing
+    - Commit/PR creation logic
+
+---
+
+## 🚨 Errors & Validation
+
+- Ensures repo has a remote and is a Git repo
+- Validates presence of commit message and branch
+- Prevents mixed usage of `--all`, `--untracked`, and file args
+- PRs auto-create branches if not found
+- Label validation before PR creation
+
+---
+
+## 🚤 Version
+
+
+## 📄 License
+
+MIT © Your Name or Organization
+
+---
+
+## 🌐 Links
+
+- GitHub: [kassett/gh-commit](https://github.com/kassett/gh-commit)
+- GH CLI: [cli.github.com](https://cli.github.com/)