tartrazine/README.md

44 lines
1.5 KiB
Markdown
Raw Normal View History

2017-06-08 07:27:27 +00:00
# enry [![GoDoc](https://godoc.org/gopkg.in/src-d/enry.v1?status.svg)](https://godoc.org/gopkg.in/src-d/enry.v1) [![Build Status](https://travis-ci.org/src-d/enry.svg?branch=master)](https://travis-ci.org/src-d/simple-linguist)
2016-12-09 12:30:21 +00:00
File programming language detector and toolbox to ignore binary or vendored files. *enry*, started as a port to _Go_ of the original [linguist](https://github.com/github/linguist) _Ruby_ library, that has an improved *performance of 100x*.
2016-12-09 12:30:21 +00:00
Installation
------------
The recommended way to install simple-linguist
```
2017-06-08 07:27:27 +00:00
go get gopkg.in/src-d/enry.v1/...
2016-12-09 12:30:21 +00:00
```
Examples
--------
```go
lang, _ := GetLanguageByExtension("foo.go")
fmt.Println(lang)
// result: Go
lang, _ = GetLanguageByContent("foo.m", "<matlab-code>")
fmt.Println(lang)
// result: Matlab
lang, _ = GetLanguageByContent("bar.m", "<pbjective-c-code>")
fmt.Println(lang)
// result: Objective-C
2017-04-05 17:03:20 +00:00
```
2017-06-08 07:27:27 +00:00
Why Enry?
---------
2017-06-09 18:27:37 +00:00
In the movie [My Fair Lady](https://en.wikipedia.org/wiki/My_Fair_Lady), [Professor Henry Higgins](http://www.imdb.com/character/ch0011719/?ref_=tt_cl_t2) is one of the main characters. Henry is a linguist and at the very beginning of the movie enjoys guessing the nationality of people based on their accent.
2017-06-08 07:27:27 +00:00
2017-06-09 18:27:37 +00:00
`Enry Iggins` is how [Eliza Doolittle](http://www.imdb.com/character/ch0011720/?ref_=tt_cl_t1), [pronounces](https://www.youtube.com/watch?v=pwNKyTktDIE) the name of the Professor during the first half of the movie.
2017-06-08 07:27:27 +00:00
2017-04-05 17:03:20 +00:00
License
-------
2017-04-17 15:57:18 +00:00
MIT, see [LICENSE](LICENSE)