Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
lotusirous committed Dec 26, 2023
1 parent a0c5e38 commit 25ee798
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Fuzzy finding go doc symbols

`stdsym` simplifies Go documentation exploration by extracting all exported
symbols from the standard library, enabling fuzzy searching through Go
symbols from the standard library, enabling fuzzy searching (fzf) through Go
documents.

## Demo

Watch a quick demo showcasing the usage of this tool:
Watch a quick demonstration showcasing the usage of this tool:

![Demo](./demo.gif)

Expand All @@ -21,6 +21,12 @@ go install github.com/lotusirous/gostdsym/stdsym@latest
Create a handy `gdoc` alias for instant symbol lookups:

```bash
$ stdsym > ~/.gostdsym
$ alias gdoc="cat ~/.gostdsym |fzf | xargs go doc "
stdsym > ~/.gostdsym
alias gdoc="cat ~/.gostdsym |fzf | xargs go doc "
```

If you want to view the results on [pkg.go.dev](https://pkg.go.dev/), use this alias. This example is for macOS, where the open command opens the link in the default browser:

```bash
alias gdocb="cat ~/.gostdsym | fzf | awk '{print \"https://pkg.go.dev/\" \$1}' | xargs open"
```

0 comments on commit 25ee798

Please sign in to comment.