Skip to content

Commit 6085e4b

Browse files
committed
docs: add auto-update feature to README
1 parent 7bdccf6 commit 6085e4b

2 files changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ A modern CLI tool to automate your daily GitHub PR and Jira workflow, written in
2828
- **Browser Integration**: Auto-open PR in browser and copy URL to clipboard
2929
- **Quick Update**: Commit and push with PR title as commit message (`qkflow update`)
3030
- **iCloud Sync**: Automatic config sync across Mac devices (macOS only) ☁️
31+
- **Auto Update**: Automatically check and install updates (configurable) 🔄
3132

3233
[![Go Version](https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat&logo=go)](https://go.dev/)
3334
[![Release](https://img.shields.io/github/v/release/Wangggym/quick-workflow?style=flat&logo=github)](https://github.com/Wangggym/quick-workflow/releases)
@@ -180,6 +181,9 @@ qkflow jira delete PROJ
180181
# Show current configuration and storage location
181182
qkflow config
182183

184+
# Update qkflow to latest version
185+
qkflow update-cli
186+
183187
# Show version
184188
qkflow version
185189

@@ -266,6 +270,7 @@ GitHub Actions will automatically:
266270
## 📚 Documentation
267271

268272
- [Getting Started Guide](./go-version/GETTING_STARTED.md) - Quick start tutorial
273+
- [Auto Update Guide](./go-version/AUTO_UPDATE.md) - Automatic update feature
269274
- [Release Guide](./go-version/RELEASE.md) - Detailed release instructions
270275
- [Release Quickstart](./go-version/RELEASE_QUICKSTART.md) - Quick release commands
271276
- [iCloud Sync Guide](./go-version/ICLOUD_MIGRATION.md) - iCloud configuration sync

go-version/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ This is a complete rewrite of the original Shell-based quick-workflow tool in Go
3131
- **Interactive CLI** - Beautiful prompts and progress indicators
3232
- **Configuration Management** - Simple setup with `qkflow init`
3333
- **iCloud Sync** - Seamlessly sync configs across all your Mac devices ☁️
34+
- **Auto Update** - Automatically check and install updates (24h interval) 🔄
3435

3536
## 📦 Installation
3637

@@ -178,6 +179,9 @@ This is perfect for quick updates to an existing PR!
178179
# Show current configuration
179180
qkflow config
180181

182+
# Update qkflow to latest version
183+
qkflow update-cli
184+
181185
# Show version
182186
qkflow version
183187

0 commit comments

Comments
 (0)