docs: add exposed lint API

README.md

@@ -72,6 +72,30 @@ Use your own project url:
 [![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Ftype-coverage%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
 ```
 
+## API
+
+```ts
+export function lint(
+  project: string,
+  detail: boolean,
+  debug: boolean,
+  files?: string[],
+  oldProgram?: ts.Program,
+  strict = false,
+  enableCache = false
+): Promise<{
+  correctCount: number
+  totalCount: numbe
+  anys: {
+    file: string
+    line: number
+    character: number
+    text: string
+  }[]
+  program: ts.Program
+}>
+```
+
 ## FAQ
 
 > Q: Does this count JavaScript files?