diff --git a/README b/README.md similarity index 63% rename from README rename to README.md index b7aeba8..174680c 100644 --- a/README +++ b/README.md @@ -1,9 +1,13 @@ -## godef - find symbol information in Go source +# godef - find symbol information in Go source Godef, given an expression or a location in a source file, prints the location of the definition of the symbol referred to. -Known limitations: +## Installation + +Run `go get github.com/rogpeppe/godef` + +## Known limitations - it does not understand about "." imports - it does not deal well with definitions in tests.