chore: make Prettier + fix spelling, update upgrade/switch instructions, prefer ale...

[webi-installers/.git] / vim-go / README.md

diff --git a/vim-go/README.md b/vim-go/README.md
index c8c5ac50e9f80b63035c6756dfd76da4dba7d30a..7b4e6ab29bbb63b529c9e5b1dc51a88c26bd1d3a 100644 (file)
--- a/vim-go/README.md
+++ b/vim-go/README.md
@@ -3,12 +3,19 @@ title: vim-go
 homepage: https://github.com/fatih/vim-go
 tagline: |
   vim-go adds Go language support for Vim.
-description: |
-  `vim-go` provides integration with various official and 3rd part go tooling for linting, vetting, etc.
-
-  You'll also need `ALE`, `syntastic`, or similar.
 ---
 
+To update (replacing the current version) run `webi vim-go`.
+
+## Cheat Sheet
+
+> `vim-go` provides integration with various official and 3rd party go tooling
+> for linting, vetting, etc.
+
+You'll also need to install [`ALE`](https://webinstall.dev/vim-ale) (part of
+[`vim-essentials`](https://webinstall.dev/vim-essentials)) or
+[`syntastic`](https://webinstall.dev/vim-syntastic) first.
+
 ### How to install by hand
 
 ```bash
@@ -17,7 +24,7 @@ git clone --depth=1 https://github.com/fatih/vim-go.git ~/.vim/pack/plugins/star
 
 ### How to configure your `.vimrc`
 
-```vimrc
+```vim
 " don't check syntax immediately on open or on quit
 let g:syntastic_check_on_open = 1
 let g:syntastic_check_on_wq = 0
@@ -26,7 +33,7 @@ let g:syntastic_check_on_wq = 0
 autocmd BufWritePre * :%s/\s\+$//e
 ```
 
-```vimrc
+```vim
 """""""""""""""""""""""""""
 " Golang-specific options "
 """""""""""""""""""""""""""
@@ -66,6 +73,9 @@ go get golang.org/x/tools/cmd/goimports
 # gorename
 go get golang.org/x/tools/cmd/gorename
 
+# goreturns
+go get github.com/sqs/goreturns
+
 # gotype
 go get golang.org/x/tools/cmd/gotype
 ```