From e9af1d7187e94a4fc62beafc40228e81090285fa Mon Sep 17 00:00:00 2001 From: "M. J. Fromberger" Date: Wed, 7 Aug 2019 11:58:33 -0700 Subject: [PATCH] Improve download and usage examples in README.md. Addresses #239. The `go get` command fetches the command-line tool, and does not match the import path for the library. To make things more clear: 1. Mention explicitly that `go get` fetches the CLI. Also, to avoid potential issues with pre-modules Go versions, do the fetch in /tmp. 2. Include an import path explicitly in the source examples. 3. Mention explicitly how to import enry into a modules build. Signed-off-by: M. J. Fromberger --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ed0d63e..016a89d 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,11 @@ File programming language detector and toolbox to ignore binary or vendored file Installation ------------ -The recommended way to install enry is to either [download a release](https://github.com/src-d/enry/releases) or +The recommended way to install the `enry` command-line tool is to either +[download a release](https://github.com/src-d/enry/releases) or run: ``` -go get github.com/src-d/enry/cmd/enry +(cd /tmp; go get github.com/src-d/enry/v2/cmd/enry) ``` This project is now part of [source{d} Engine](https://sourced.tech/engine), @@ -32,9 +33,22 @@ Visit [sourced.tech/engine](https://sourced.tech/engine) for more information. Examples ------------- +-------- + +If you are working in a [Go module](https://github.com/golang/go/wiki/Modules), +import `enry` to the module by running: ```go +go get github.com/src-d/enry/v2 +``` + +The rest of the examples will assume you have either done this or fetched the +library into your `GOPATH`. + +```go +// The examples here and below assume you have imported the library. +import "github.com/src-d/enry/v2" + lang, safe := enry.GetLanguageByExtension("foo.go") fmt.Println(lang, safe) // result: Go true