ralsina/tartrazine
1
0
Fork 0
mirror of https://github.com/ralsina/tartrazine.git synced 2024-11-10 05:22:23 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #240 from creachadair/whats-up-doc

Browse Source 
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.
This commit is contained in:
M. J. Fromberger 2019-08-08 11:14:44 -07:00 committed by GitHub
commit fd3c31c313
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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