Skip to content

Commit 6d668d5

Browse files
committed
docs(readme): update README
1 parent 0327a96 commit 6d668d5

1 file changed

Lines changed: 34 additions & 6 deletions

File tree

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ reads your staged diff · suggests conventional commits · you pick one · done
1010
[![Go Version](https://img.shields.io/badge/go-1.21+-00ADD8.svg)](https://go.dev)
1111
[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macOS%20%7C%20windows-lightgrey.svg)](#install)
1212
[![No Telemetry](https://img.shields.io/badge/telemetry-none-brightgreen.svg)](#security)
13-
[![part of aysdog](https://img.shields.io/badge/part%20of-aysdog-orange.svg)](https://aysdog.pages.dev)
13+
[![part of aysdog](https://img.shields.io/badge/part%20of-aysdog-orange.svg)](https://aysdog.com)
1414

1515
[![Star History Chart](https://api.star-history.com/svg?repos=aysdog/commitdog&type=Date)](https://star-history.com/#aysdog/commitdog&Date)
1616

@@ -102,6 +102,27 @@ pick a number. press enter to push. that's the whole thing.
102102

103103
---
104104

105+
## branch, sync, stash
106+
107+
```sh
108+
# switch branches fast
109+
commitdog branch
110+
111+
# create a new branch
112+
commitdog branch create
113+
114+
# fetch + rebase + push in one shot
115+
commitdog sync
116+
117+
# save work in progress
118+
commitdog stash
119+
120+
# update commitdog itself
121+
commitdog --update
122+
```
123+
124+
---
125+
105126
## made a mistake? revert it
106127

107128
```sh
@@ -173,12 +194,19 @@ commitdog init
173194

174195
| command | what it does |
175196
|---------|-------------|
176-
| `commitdog` | suggest commit message for staged changes |
197+
| `commitdog` | suggest commit message for staged changes, commit, ask to push |
177198
| `commitdog revert` | pick from last 5 commits and revert |
178199
| `commitdog init` | create a GitHub repo and do the first push |
179200
| `commitdog setup` | configure email and GitHub token (do once) |
180-
| `commitdog --version` | print version |
181-
| `commitdog --help` | print help |
201+
| `commitdog branch` | interactive branch switcher — 5 suggestions + type any name |
202+
| `commitdog branch create` | create new branch with optional base, push with upstream |
203+
| `commitdog branch ls` | list all local and remote branches |
204+
| `commitdog branch delete` | delete branch locally + optionally remote |
205+
| `commitdog sync` | fetch + pull rebase + push in one command |
206+
| `commitdog stash` | save, pop, or drop stashes interactively |
207+
| `commitdog --update` | update to latest release automatically |
208+
| `commitdog --version` | print version and ascii art |
209+
| `commitdog --help` | print full help |
182210

183211
---
184212

@@ -233,7 +261,7 @@ commitdog is designed to never leak your data.
233261
| token in git ops | never used — SSH or HTTPS handles push, token only for API |
234262
| diff size | capped at 200KB — no memory issues |
235263
| commit messages | sanitized before passing to git |
236-
| network | zero outbound connections except `commitdog init` (GitHub API) |
264+
| network | zero outbound except `commitdog init` (GitHub API) and push/sync (your git remote) |
237265
| dependencies | pure Go stdlib — no third-party packages |
238266

239267
you can read the entire source in 20 minutes. nothing is hidden.
@@ -255,4 +283,4 @@ everything else is negotiable.
255283

256284
commitdog is part of [aysdog](https://aysdog.com) — open-source tools for developers who hate bloat.
257285

258-
zero telemetry · self-hostable · single binary · MIT licensed
286+
zero telemetry · self-hostable · single binary · MIT licensed

0 commit comments

Comments
 (0)