diff --git a/README.md b/README.md index 5b08604..fed4f33 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,25 @@ # Git It +[![CI](https://github.com/ashproto/git-it/actions/workflows/ci.yml/badge.svg)](https://github.com/ashproto/git-it/actions/workflows/ci.yml) +[![Latest release](https://img.shields.io/github/v/release/ashproto/git-it?sort=semver&display_name=tag)](https://github.com/ashproto/git-it/releases/latest) +[![Downloads](https://img.shields.io/github/downloads/ashproto/git-it/total)](https://github.com/ashproto/git-it/releases) +![Platform](https://img.shields.io/badge/platform-macOS%2012.3%2B-000000?logo=apple&logoColor=white) +![Built with Tauri](https://img.shields.io/badge/built%20with-Tauri%202%20%2B%20SvelteKit-24C8DB?logo=tauri&logoColor=white) + +

+ Git It — the commit graph, refs sidebar, and toolbar +

+ A fast, native **macOS git client** — commit graph, branches, merges, rebases, working-copy diffs, and remotes — with **first-class commit-time editing**. Built with [Tauri 2](https://tauri.app) (Rust) and [SvelteKit 5](https://svelte.dev) (runes). > macOS only. The window uses native vibrancy (frosted-glass panels over the desktop) via `NSVisualEffect`. +## Download + +**[⬇ Download the latest release](https://github.com/ashproto/git-it/releases/latest)** — open the `.dmg`, drag **Git It.app** into `/Applications`, and launch. It keeps itself up to date after that (in-app auto-updates, with an optional beta channel in Settings → Updates). + +> Requires **macOS 12.3+**. The release ships separate **Apple Silicon** and **Intel** builds — download the `.dmg` that matches your Mac (each runs fully native). In-app updates then track the right build automatically. + ## Features - **Commit graph** — multi-lane history with curved or angular edges, ref badges (branches, tags, remotes, `HEAD`), infinite-scroll loading, and selectable rows. @@ -16,6 +32,23 @@ A fast, native **macOS git client** — commit graph, branches, merges, rebases, - **Commit-time editing** — select commits and shift them by an **offset**, set an **exact** time, or **compress** a range proportionally into a new window. Opens in an on-demand drawer; previews before it rewrites. - **Multi-repo** — open several repositories at once, as tabs or a sidebar list (your choice). +## Screenshots + +

+ Git It — a commit's changed files and a syntax-highlighted diff
+ Inspect any commit — changed files and a syntax-highlighted diff, unified or split, with per-hunk staging. +

+ +

+ Git It — the built-in GitHub dashboard for a repository
+ Built-in GitHub — pull requests, issues, releases, and CI runs, right next to your local history. +

+ +

+ Git It — Settings with graph, date, and auto-update options
+ Settings — graph styling, date formatting, and in-app auto-updates with an optional beta channel. +

+ ## Prerequisites Git It shells out to the system `git`, so you need it on `PATH`: diff --git a/docs/screenshots/commit-graph.png b/docs/screenshots/commit-graph.png new file mode 100644 index 0000000..652a710 Binary files /dev/null and b/docs/screenshots/commit-graph.png differ diff --git a/docs/screenshots/diff-viewer.png b/docs/screenshots/diff-viewer.png new file mode 100644 index 0000000..627ef03 Binary files /dev/null and b/docs/screenshots/diff-viewer.png differ diff --git a/docs/screenshots/github.png b/docs/screenshots/github.png new file mode 100644 index 0000000..baafc70 Binary files /dev/null and b/docs/screenshots/github.png differ diff --git a/docs/screenshots/settings.png b/docs/screenshots/settings.png new file mode 100644 index 0000000..0aad9d4 Binary files /dev/null and b/docs/screenshots/settings.png differ