Minimal project description & metadata

README.md

@@ -1,3 +1,11 @@
-# JUnit Check Report
+**WIP**
 
-** WIP **
+# Test Check Report
+
+Goal of this project is to create [Github Action](https://github.com/features/actions)
+that could presents test results from popular testing frameworks as Github check run with code annotation in places where test failed.
+
+Support for following test reports are planned for initial release:
+- [ ] dotnet-trx: [`dotnet test --logger trx`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#examples)
+- [ ] flutter-machine: `flutter test --machine`
+- [ ] jest-junit: [`jest --ci --reporters=jest-junit`](https://github.com/jest-community/jest-junit#readme)

action.yml

@@ -1,7 +1,26 @@
-name: 'JUnit Check Report'
+name: 'Test Check Reporter'
-description: 'Presents results of junit test report as Github check run'
+description: |
+  Presents test results from popular testing frameworks as Github check run.
+  Supports:
+    - dotnet (trx logger)
+    - flutter (JSON output with '--machine' flag )
+    - jest (jest-junit reporter)
+
 author: 'Michal Dorner <dorner.michal@gmail.com>'
 inputs:
+  name:
+    description: 'Name of the check run'
+    required: true
+  path:
+    description: 'Path to test report'
+    required: true
+  reporter:
+    description: |
+      Format of test report. Supported options:
+        - dotnet-trx
+        - flutter-machine
+        - jest-junit
+    required: true
   token:
     description: 'GitHub Access Token'
     required: false

package.json

@@ -2,7 +2,7 @@
   "name": "junit-check",
   "version": "0.0.0",
   "private": true,
-  "description": "Presents results of junit test report as Github check run",
+  "description": "Presents test results from popular testing frameworks as Github check run",
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc",
@@ -15,7 +15,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dorny/junit-check.git"
+    "url": "git+https://github.com/dorny/test-check.git"
   },
   "keywords": [
     "actions",