Skip to content

Commit 3219bad

Browse files
JheisonMBCopilot
andcommitted
doc: improve readme
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 5ab4c94 commit 3219bad

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,27 @@
1717
[![Crates.io](https://img.shields.io/crates/v/gitkit)](https://crates.io/crates/gitkit)
1818
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
1919

20-
Configure a git repo in seconds — hooks, `.gitignore`, `.gitattributes`, and git config. Interactive wizard or direct commands. No Node.js, no Python, no runtime dependencies. One binary.
20+
Set up a git repo the way you actually work — one guided flow for hooks, `.gitignore`, `.gitattributes`, and git config. One binary, no Node.js, no Python, no runtime dependencies.
2121

2222
---
2323

24+
### Demo
25+
2426
![Demo](assets/demo.gif)
2527

2628
---
2729

30+
## Features
31+
32+
- **🪄 Guided repo setup** — Configure hooks, `.gitignore`, `.gitattributes`, and git config in one interactive flow.
33+
- **🔁 Clone and bootstrap** — Clone a repo and drop straight into the setup wizard.
34+
- **🧰 Hook management** — Install, list, show, or remove built-in hooks, or wire up your own command.
35+
- **🧩 Ignore and attribute presets** — Browse built-in and gitignore.io templates, then apply line-ending or binary presets.
36+
- **⚙️ Curated git config** — Apply practical presets like auto-upstream, autocorrect, histogram diffs, zdiff3, rerere, and delta pager setup.
37+
- **📦 Single binary** — No Node.js, no Python, no extra runtime.
38+
39+
---
40+
2841
## Installation
2942

3043
### Quick install (recommended)
@@ -209,3 +222,14 @@ Built-ins are embedded in the binary — no network required.
209222
## License
210223

211224
MIT
225+
226+
---
227+
## Support
228+
229+
- 📖 [GitHub Issues](https://github.com/UniverLab/gitkit/issues) — Report bugs or request features
230+
- 💬 [Discussions](https://github.com/UniverLab/gitkit/discussions) — Ask questions
231+
- 🐦 Twitter: [@JheisonMB](https://twitter.com/JheisonMB)
232+
233+
---
234+
235+
Made with ❤️ by [JheisonMB](https://github.com/JheisonMB) and [UniverLab](https://github.com/UniverLab)

0 commit comments

Comments
 (0)