Skip to content

Commit 68d383f

Browse files
authored
Merge pull request #11 from UniverLab/develop
docs: add demo to readme
2 parents b701bb5 + 7c1c70d commit 68d383f

4 files changed

Lines changed: 35 additions & 7 deletions

File tree

.github/workflows/release.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ env:
1919
jobs:
2020
create-tag:
2121
name: Create Release Tag
22-
if: github.event.pull_request.merged == true
22+
if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
2323
runs-on: ubuntu-latest
2424
outputs:
2525
tag: ${{ steps.version.outputs.tag }}
@@ -33,7 +33,7 @@ jobs:
3333
- name: Get version from Cargo.toml
3434
id: version
3535
run: |
36-
VERSION=$(grep '^version = ' Cargo.toml | head -1 | sed 's/version = "\(.*\)"/\1/' | tr -d '\r')
36+
VERSION=$(grep '^version = ' Cargo.toml | head -1 | sed 's/version = "\(.*\)"/\1/' | tr -d '\r' | xargs)
3737
TAG="v${VERSION}"
3838
echo "version=${VERSION}" >> $GITHUB_OUTPUT
3939
echo "tag=${TAG}" >> $GITHUB_OUTPUT
@@ -108,15 +108,15 @@ jobs:
108108
if: matrix.archive == 'tar.gz'
109109
run: |
110110
cd target/${{ matrix.target }}/release
111-
tar czf ../../../gitkit-${{ needs.create-tag.outputs.tag }}-${{ matrix.target }}.tar.gz gitkit
111+
tar czf "../../../gitkit-${{ needs.create-tag.outputs.tag }}-${{ matrix.target }}.tar.gz" gitkit
112112
cd ../../..
113113
114114
- name: Package (windows)
115115
if: matrix.archive == 'zip'
116116
shell: pwsh
117117
run: |
118118
cd target/${{ matrix.target }}/release
119-
Compress-Archive -Path gitkit.exe -DestinationPath ../../../gitkit-${{ needs.create-tag.outputs.tag }}-${{ matrix.target }}.zip
119+
Compress-Archive -Path gitkit.exe -DestinationPath "../../../gitkit-${{ needs.create-tag.outputs.tag }}-${{ matrix.target }}.zip"
120120
cd ../../..
121121
122122
- name: Upload artifact
@@ -199,7 +199,7 @@ jobs:
199199
- name: Check if stable release
200200
id: version_check
201201
run: |
202-
VERSION=$(grep '^version = ' Cargo.toml | sed 's/.*"\(.*\)".*/\1/')
202+
VERSION=$(grep '^version = ' Cargo.toml | head -1 | sed 's/.*"\(.*\)".*/\1/' | xargs)
203203
if [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
204204
echo "is_stable=true" >> $GITHUB_OUTPUT
205205
echo "Version $VERSION is stable — will publish"

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "gitkit"
3-
version = "0.3.0"
3+
version = "0.3.1"
44
edition = "2021"
55
description = "Standalone CLI for configuring git repos — hooks, .gitignore, and .gitattributes"
66
license = "MIT"

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,24 @@
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.
21+
22+
---
23+
24+
### Demo
25+
26+
![Demo](assets/demo.gif)
27+
28+
---
29+
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.
2138

2239
---
2340

@@ -205,3 +222,14 @@ Built-ins are embedded in the binary — no network required.
205222
## License
206223

207224
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)

assets/demo.gif

202 KB
Loading

0 commit comments

Comments
 (0)