docs: Updated README

roman.vasilev · roman.vasilev · commit 32e1449e463e · 2018-08-24T20:51:06.000+04:00
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-typescript-service
-===
+# typescript-service
 Language service which helps to get diagnostic messages from typescript source files.
 
 ## INSTALL
@@ -16,22 +15,25 @@ const diagnostics = service.getDiagnostics(fileName);
 ```
 
 ## API
-```
-createService({ configFile, compilerOptions })
-```
-`configFile` (required, string) Path to tsconfig.json file  
-`compilerOptions` (optional, Object) Compiler options to overwrite defined in tsconfig.json  
+
+#### createService({ configFile: string, compilerOptions?: ts.CompilerOptions })
+* `configFile` (required, string) Path to tsconfig.json file
+* `compilerOptions` (optional, Object) Compiler options to overwrite defined in tsconfig.json
 
 Returns object with properties which are functions:
 
-* `update({ fileName: string, fileContent?: string })` Update (add) information about file in typescript service  
-`fileName` (required, string) Path to typescript file  
-`fileContent (optional, string)` File content of this file  
+##### getSourceFile({ fileName: string, sourceText?: string })
+Update (add) information about file in typescript service.
+* `fileName` (required, string) Path to typescript file
+* `sourceText` (optional, string) File content of this file
 
-* `getDiagnostics(fileName: string): Array<ts.DiagnosticWithLocation>` Get diagnostic messages for `fileName`  
-`fileName` (required, string) Path to typescript file  
+##### getDiagnostics: (fileName: string, sourceText?: string): Array<ts.DiagnosticWithLocation>
+Get diagnostic messages for `fileName`
+* `fileName` (required, string) Path to typescript file
+* `sourceText` (optional, string) If path outside of scope defined in tsconfig you need provide `sourceText`
 
-* `getProgram(): ts.Program` Get `ts.Program`  
+##### getProgram(): ts.Program
+Get `ts.Program`
 
 ## CHANGELOG
 See [CHANGELOG.md](CHANGELOG.md)
diff --git a/package.json b/package.json
@@ -26,7 +26,9 @@
     "clean": "rimraf dist",
     "commit": "git-cz"
   },
-  "dependencies": {},
+  "dependencies": {
+    "tslib": "^1.9.3"
+  },
   "devDependencies": {
     "@semantic-release/changelog": "^3.0.0",
     "@semantic-release/git": "^7.0.2",
diff --git a/tsconfig.json b/tsconfig.json
@@ -3,9 +3,11 @@
     "target": "es5",
     "module": "commonjs",
     "moduleResolution": "node",
+    "importHelpers": true,
     "declaration": false,
     "outDir": "dist",
     "removeComments": false,
+    "strict": true,
     "sourceMap": true,
     "lib": [
       "esnext"
