Issue/12 improve documentation (#13)

* added some more structure to the documentation

* updte

Author: tom171296

README.md

@@ -1,23 +1,7 @@
-# Run Stryker.NET v1
+# Run Stryker GitHub Action
 
 This action runs [Stryker.NET](https://stryker-mutator.io/docs/stryker-net/introduction/) on your specified test project.
 
-# What's new
-- Run [Stryker.Net](https://stryker-mutator.io/docs/stryker-net/introduction/) in your github with a single action
-    - Have the stryker HTML report available in your workspace
-- Fail the action run if your mutation score isn't met
-    
-
-# Usage
-
-See [action.yml](./action.yml)
-
-## Run Stryker.Net on a single test project
-```
-uses: tom171296/run-stryker-net@vmain
-  with:
-    testProject: "BusinessLogic.Test/" # required
-```
 ## Inputs
 
 ### `testProject`
@@ -30,11 +14,13 @@ uses: tom171296/run-stryker-net@vmain
 
 ## Outputs
 
-There are no outputs from this action.
+### `html-report`
+
+This action generates an HTML report from the Stryker run, which can be uploaded as an artifact.
 
 ## Example usage
 
-``` yaml
+```yaml
 # File: .github/workflows/mutation-test.yaml
 
 on:
@@ -46,13 +32,12 @@ jobs:
   mutation-test:
     uses: actions/checkout@v3
 
-    uses: tom171296/run-stryker-net@main
+    uses: stryker-mutator/github-action@v0.0.1
       with:
         testProject: "BusinessLogic.Test/" # required
         breakAt: "75" # Optional
 
     uses: actions/upload-artifact@v3
-    with:
-      name: html-report
-      path: ${{github.workspace}}/BusinessLogic.Test/StrykerOutput/**/**/*.html
-```
+      with:
+        name: html-report
+        path: ${{github.workspace}}/BusinessLogic.Test/StrykerOutput/**/**/*.html