Merge pull request palantir#693 from palantir/fix-typings

Fix typing bug and make Readme clearer

README.md

@@ -246,10 +246,11 @@ TSLint ships with a set of core rules that can be configured. However, users are
 
 Rule names are always camel-cased and *must* contain the suffix `Rule`. Let us take the example of how to write a new rule to forbid all import statements (you know, *for science*). Let us name the rule file `noImportsRule.ts`. Rules can be referenced in `tslint.json` in their dasherized forms, so `"no-imports": true` would turn on the rule.
 
-Now, let us first write the rule in TypeScript. At the top, we reference TSLint's [definition](https://github.com/palantir/tslint/blob/master/lib/tslint.d.ts) file. The exported class name must always be named `Rule` and extend from `Lint.Rules.AbstractRule`.
+Now, let us first write the rule in TypeScript. At the top, we reference TSLint's [definition file](https://github.com/palantir/tslint/blob/master/lib/tslint.d.ts) and the [definition file](https://github.com/palantir/tslint/blob/master/typings/typescriptServices.d.ts) for TypeScript's language services. The exported class must always be named `Rule` and extend from `Lint.Rules.AbstractRule`.
 
 ```typescript
-/// <reference path='tslint.d.ts' />
+/// <reference path='typings/typescriptServices.d.ts' />
+/// <reference path='lib/tslint.d.ts' />
 
 export class Rule extends Lint.Rules.AbstractRule {
     public static FAILURE_STRING = "import statement forbidden";
@@ -316,7 +317,7 @@ Custom Formatters
 Just like rules, additional formatters can also be supplied to TSLint via `--formatters-dir` on the CLI or `formattersDirectory` option on the library or `grunt-tslint`. Writing a new formatter is simpler than writing a new rule, as shown in the JSON formatter's code.
 
 ```javascript
-/// <reference path='tslint.d.ts' />
+/// <reference path='lib/tslint.d.ts' />
 
 export class Formatter extends Lint.Formatters.AbstractFormatter {
     public format(failures: Lint.RuleFailure[]): string {

lib/tslint.d.ts

@@ -265,5 +265,6 @@ declare module Lint {
     }
 }
 declare module "tslint" {
-    export = Lint;
+    import Linter = Lint.Linter;
+    export = Linter;
 }

src/tslint.ts

@@ -114,5 +114,6 @@ module.exports = Lint.Linter;
 module.exports.findConfiguration = Lint.Configuration.findConfiguration;
 
 declare module "tslint" {
-    export = Lint;
+    import Linter = Lint.Linter;
+    export = Linter;
 }