From f16fdab75e0305d523ce2ae0ec4b3a6e1eec8b96 Mon Sep 17 00:00:00 2001 From: BSKY Date: Sat, 4 Apr 2020 11:25:55 +0900 Subject: [PATCH] Tweaks --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ad2f5f0..a8e13ec 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # TypeScript Error Reporter Action -Ensuring type-safetiness is one of the most critical responsibility for modern software developers. +Ensuring type safety is one of the most important responsibilities of modern software developers. -This Action will provide you the easiest way to run type checks and see the result for each Pull Requests. +This action uses the [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) to run a static type check on your code and display the results of the check. ![TypeScript Error Reporter Action](https://user-images.githubusercontent.com/8381075/78413929-a40f0680-7654-11ea-8365-0ef72fb4d6b3.png) -## Usage +## Example Configuration -This Action uses [TypeScript Compiler API](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API) to satically run diagnostics over your app and shows you the result of the checks. +`.github/workflows/test.yml`: ```yaml name: Test @@ -32,7 +32,7 @@ jobs: uses: andoshin11/typescript-error-reporter-action@v1.0.0 ``` -whereas your `tsconfig.json` should look like this. +`tsconfig.json`: ```json {