From 7bfdd4086e59ef9d2529c62726eafe060044119f Mon Sep 17 00:00:00 2001 From: Ted Nyman Date: Sat, 28 Dec 2013 19:41:06 -0800 Subject: [PATCH] Update README for new output --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4647dafd..65565a40 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ We use this library at GitHub to detect blob languages, highlight code, ignore b ### Language detection -Linguist defines the list of all languages known to GitHub in a [yaml file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). In order for a file to be highlighted, a language and lexer must be defined there. +Linguist defines the list of all languages known to GitHub in a [yaml file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). In order for a file to be highlighted, a language and lexer must be defined there. Most languages are detected by their file extension. This is the fastest and most common situation. @@ -46,6 +46,10 @@ These stats are also printed out by the `linguist` binary. You can try running ` $ bundle exec linguist lib/ 100% Ruby + Ruby: ["linguist/blob_helper.rb", "linguist/classifier.rb", "linguist/file_blob.rb", "linguist/generated.rb", + "linguist/heuristics.rb", "linguist/language.rb", "linguist/md5.rb", "linguist/repository.rb", + "linguist/samples.rb", "linguist/tokenizer.rb", "linguist.rb"] + #### Ignore vendored files Checking other code into your git repo is a common practice. But this often inflates your project's language stats and may even cause your project to be labeled as another language. We are able to identify some of these files and directories and exclude them.