Skip to content

Commit 80a983d

Browse files
committed
cuc
1 parent fedc32e commit 80a983d

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@ Tired of grep-ing through thousands of lines trying to figure out which structs
66

77
## Installation 🚀
88

9+
### Option 1: Install it
910
```bash
1011
go install github.com/psyb0t/gofindimpl@latest
1112
```
1213

13-
Or clone and build like it's 2005:
14+
### Option 2: Run directly (no installation needed)
15+
```bash
16+
go run github.com/psyb0t/gofindimpl@latest -interface ./path/to/file.go:InterfaceName -dir ./search/directory
17+
```
1418

19+
### Option 3: Clone and build like it's 2005
1520
```bash
1621
git clone https://github.com/psyb0t/gofindimpl.git
1722
cd gofindimpl
@@ -20,22 +25,38 @@ go build -o gofindimpl
2025

2126
## Usage 💀
2227

23-
### Basic Hunt
28+
### Basic Hunt (installed)
2429

2530
```bash
2631
gofindimpl -interface ./path/to/file.go:InterfaceName -dir ./search/directory
2732
```
2833

29-
### Real Example
34+
### Basic Hunt (direct run)
35+
36+
```bash
37+
go run github.com/psyb0t/gofindimpl@latest -interface ./path/to/file.go:InterfaceName -dir ./search/directory
38+
```
39+
40+
### Real Example (installed)
3041

3142
```bash
3243
gofindimpl -interface ./internal/app/server.go:Server -dir ./internal/pkg/
3344
```
3445

46+
### Real Example (direct run)
47+
48+
```bash
49+
go run github.com/psyb0t/gofindimpl@latest -interface ./internal/app/server.go:Server -dir ./internal/pkg/
50+
```
51+
3552
### With Debug Logging (for masochists)
3653

3754
```bash
55+
# Installed
3856
gofindimpl -interface ./internal/app/server.go:Server -dir ./internal/pkg/ -debug
57+
58+
# Direct run
59+
go run github.com/psyb0t/gofindimpl@latest -interface ./internal/app/server.go:Server -dir ./internal/pkg/ -debug
3960
```
4061

4162
## Output Format 📋

0 commit comments

Comments
 (0)