docs: add some comments, update and fix readme

README.md

@@ -2,17 +2,25 @@
 [![Travis build](https://travis-ci.org/yisraelx/karma-tslint.svg?branch=master)](https://travis-ci.org/yisraelx/karma-tslint)
 [![Version](https://img.shields.io/npm/v/karma-tslint.svg)](https://www.npmjs.com/package/karma-tslint)
 [![MIT License](https://img.shields.io/npm/l/karma-tslint.svg)](https://github.com/yisraelx/karma-tslint/blob/master/LICENSE)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![TypeScript](https://img.shields.io/badge/100%25-TypeScript-blue.svg)](https://www.typescriptlang.org)
+[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
+**Adapter for the [Tslint](https://palantir.github.io/tslint), linter for the [TypeScript](https://www.typescriptlang.org) language.**
+
+> _Warning: [Tslint](https://palantir.github.io/tslint) soon will be deprecated ([Roadmap: TSLint → ESLint](https://github.com/palantir/tslint/issues/4534)), 
+[karma-tslint](https://github.com/yisraelx/karma-tslint) will continue to be updated accordingly._
+
 ## Install
 ```bash
-$ npm install --save-dev karma-tslint
-# and install peer dependencies
-$ npm install --save-dev tslint
+$ yarn add karma-tslint tslint --dev
 ```
+Or
+```bash
+$ npm install karma-tslint tslint --save-dev
+```
+
 ## Use
-### Config
 
 ```typescript
 // karma.conf.ts
@@ -69,7 +77,7 @@ __fix__
 * undefined (default) - false
 
 __project__ - for rules that need `typescript` program
-* string - path to the tsconfig.json file or to the directory containing the tsconfig.json file
+* string - path to 'tsconfig.json' file or to the directory containing the 'tsconfig.json' file
 * undefined (default) - run without `typescript` program
 
 ### Karma plugins option

package.json

@@ -1,7 +1,7 @@
 {
   "name": "karma-tslint",
   "version": "0.0.0-development",
-  "description": "Karma tslint plugin",
+  "description": "Adapter for the Tslint, linter for the TypeScript language.",
   "main": "lib/index.js",
   "typeings": "lib/index.d.ts",
   "files": [

src/tslint.preprocessor.ts

@@ -57,7 +57,7 @@ export interface ITslintPreprocessorConfig {
     /**
      * For rules that need `typescript` program
      *
-     * string - path to the tsconfig.json file or to the directory containing the tsconfig.json file
+     * string - path to the 'tsconfig.json' file or to the directory containing the 'tsconfig.json' file
      * undefined (default) - run without `typescript` program
      */
     project?: string;
@@ -123,7 +123,7 @@ export class TslintPreprocessor extends Linter {
     private getConfiguration(filePath: string): Configuration.IConfigurationFile {
         let {configuration} = this._config as any;
 
-        if (configuration === void 0) {
+        if (configuration === void 0) { // auto search for 'tslint.json' file.
             configuration = Linter.findConfigurationPath(null, filePath);
         }
 
@@ -134,9 +134,9 @@ export class TslintPreprocessor extends Linter {
             configuration = 'tslint:recommended';
         }
 
-        if (typeof configuration === 'string') {
+        if (typeof configuration === 'string') { // path of tslint.json file or tslint preset 'tslint:{all,latest,recommended}'.
             configuration = Configuration.loadConfigurationFromPath(configuration as string);
-        } else if (typeof configuration === 'object') {
+        } else if (typeof configuration === 'object') { // tslint config object.
             configuration = Configuration.parseConfigFile(configuration as any);
         }
 
@@ -151,4 +151,4 @@ export class TslintPreprocessor extends Linter {
         return result;
     }
 
-}
+}