tartrazine/README.md
Máximo Cuadros 45f82764b0 travis
2017-04-05 19:21:01 +02:00

36 lines
1.0 KiB
Markdown

# simple-linguist [![GoDoc](https://godoc.org/gopkg.in/src-d/simple-linguist.v1?status.svg)](https://godoc.org/gopkg.in/src-d/simple-linguist.v1) [![Build Status](https://travis-ci.org/src-d/simple-linguist.svg?branch=master)](https://travis-ci.org/src-d/simple-linguist)
File language detector and toolbox to ignore binary or vendored files. *simple-linguist*, is our port to _Go_ of the original [lignuist](https://github.com/github/linguist) _Ruby_ library, with fewer precision in arcane languages but with an improved *performance of 100x*.
Installation
------------
The recommended way to install simple-linguist
```
go get gopkg.in/src-d/simple-linguist.v1/...
```
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
```
License
-------
MIT, see [LICENSE](LICENSE)