Skip to content

Commit a4ccf65

Browse files
committed
refactor: restructure README with prominent quick install section
- Add quick install section at top with recommended macOS method - Remove go install option to avoid version caching issues - Replace with GitHub Releases download for cross-platform support - Improve visual hierarchy with emojis and clearer headings
1 parent 912c096 commit a4ccf65

1 file changed

Lines changed: 36 additions & 16 deletions

File tree

README.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,67 @@
11
# Git Open
22

3-
[![Go Report Card](https://goreportcard.com/badge/github.com/zhaochunqi/git-open)](https://goreportcard.com/report/github.com/zhaochunqi/git-open) [![codecov](https://codecov.io/github/zhaochunqi/git-open/graph/badge.svg?token=TXC9ZOSHFT)](https://codecov.io/github/zhaochunqi/git-open)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/zhaochunqi/git-open)](https://goreportcard.com/report/github.com/zhaochunqi/git-open) [![codecov](https://codecov.io/github.com/zhaochunqi/git-open/graph/badge.svg?token=TXC9ZOSHFT)](https://codecov.io/github.com/zhaochunqi/git-open)
44

5-
This is a Go-based tool that allows you to open the current repository in a web browser. It's a simple yet efficient solution for quickly accessing your project's online resources.
5+
## 🚀 Quick Install
6+
7+
### Recommended (macOS)
8+
```sh
9+
brew install --cask zhaochunqi/tap/git-open
10+
```
11+
12+
13+
14+
---
15+
16+
A Go-based tool that allows you to open the current repository in a web browser with a single command. It's a simple yet efficient solution for quickly accessing your project's online resources.
617

718
## Features
819

920
* Easy Access: Open your repository in a web browser with a single command.
1021
* Cross-Platform: Built using Go, the tool is compatible with various operating systems.
1122
* Lightweight: Minimal dependencies and efficient code ensure the tool runs smoothly.
1223

13-
## Installation
24+
## Installation Options
1425

1526
There are multiple ways to install the tool:
1627

17-
### Using Go
28+
### Homebrew (macOS) - Recommended
1829

19-
Ensure you have Go installed on your system. Then, use the following command:
30+
The easiest method for macOS users with automatic updates:
2031

2132
```sh
22-
go install github.com/zhaochunqi/git-open@latest
33+
brew install --cask zhaochunqi/tap/git-open
2334
```
2435

25-
### Using mise with ubi
36+
### GitHub Releases
2637

27-
If you prefer using mise, you can install the tool with:
38+
Download the pre-compiled binary for your platform:
2839

2940
```sh
30-
mise use -g ubi:zhaochunqi/git-open
41+
# macOS (Intel)
42+
curl -L https://github.com/zhaochunqi/git-open/releases/latest/download/git-open-darwin-amd64 -o git-open
43+
chmod +x git-open
44+
sudo mv git-open /usr/local/bin/
45+
46+
# macOS (Apple Silicon)
47+
curl -L https://github.com/zhaochunqi/git-open/releases/latest/download/git-open-darwin-arm64 -o git-open
48+
chmod +x git-open
49+
sudo mv git-open /usr/local/bin/
50+
51+
# Linux (x64)
52+
curl -L https://github.com/zhaochunqi/git-open/releases/latest/download/git-open-linux-amd64 -o git-open
53+
chmod +x git-open
54+
sudo mv git-open /usr/local/bin/
3155
```
3256

33-
This method allows for easy version management and isolation.
34-
35-
### Using Homebrew
57+
### mise with ubi
3658

37-
If you have Homebrew installed, you can install the tool via our Homebrew tap:
59+
For users who prefer mise for version management:
3860

3961
```sh
40-
brew install --cask zhaochunqi/tap/git-open
62+
mise use -g ubi:zhaochunqi/git-open
4163
```
4264

43-
This is the recommended method for macOS users as it provides easy updates and management.
44-
4565
## Usage
4666

4767
Navigate to your project's directory and run the following command:

0 commit comments

Comments
 (0)