added readme

Iddo Gino · Iddo Gino · commit ae6f6b45bddc · 2020-10-12T22:41:13.000-07:00
diff --git a/README.md b/README.md
@@ -1 +1,60 @@
-##TBD
+# RapidAPI Testing GitHub Actions
+
+This GitHub Action allows you to trigger the execution of RapidAPI Testing tests.
+
+## Complete example
+
+```yaml
+on: [push]
+
+jobs:
+  run_api_test:
+    runs-on: ubuntu-latest
+    name: Execute RapidAPI API Tests
+    steps:
+    - name: Execute Tests
+      id: tstExec
+      uses: RapidAPI/gh-api-testing-trigger@master
+      with:
+        test: 'YOUR_TEST_ID'
+        location: 'AWS-US-WEST-2'
+        environment: 'ENV_ID(OPTIONAL)'
+    - name: Show Results
+      run: echo "The test took ${{ steps.tstExec.outputs.time }}ms to run"; echo "The test result was ${{ steps.tstExec.outputs.succesful }}"; echo "View Report - {{ steps.tstExec.outputs.reportUrl }}"
+```
+
+## Inputs
+
+### `test`
+**Required** The ID of the test you wish to execute.
+
+### `location`
+**Required** The location the test will be executed in. Options:
+
+- `AWS-US-EAST-1` : N. Virginia
+- `AWS-US-WEST-2` : Oregon
+- `AWS-AP-EAST-1` : Hong Kong
+- `AWS-AP-SOUTH-1` : Mumbai
+- `AWS-AP-SOUTHEAST-1` : 
+- `AWS-AP-NORTHEAST-1` : Tokyo
+- `AWS-EU-CENTRAL-1` : Frankfurt
+- `AWS-EU-WEST-3` : Paris
+- `AWS-SA-EAST-1` : São Paulo
+
+### `location`
+The environment you want to run the test in. If you don't use environment omit this parameter
+
+## Outputs
+
+### `time`
+The time it took the test to execute, in miliseconds (1000ms=s)
+
+### `succesful`
+True/false based on the result of the test execution
+
+### `reportUrl`
+URL of a human readable report of the test execution
+
+## Help
+
+For any help using this integration, reach out to `support@rapidapi.com`.
diff --git a/action.yml b/action.yml
@@ -12,8 +12,12 @@ inputs:
     description: 'The environment ID the test will run in'
     required: false
 outputs:
-  executionTime:
+  time:
     description: 'How long the test took to execute'
+  succesful:
+    description: 'True or false based on the outcome of the test execution'
+  reportUrl:
+    description: 'Url for the full test execution URL'
 runs:
   using: 'node12'
   main: 'index.js'
diff --git a/index.js b/index.js
@@ -52,6 +52,7 @@ core.group('Execute Test', async () => {
     // 3. Set Response Data
     core.setOutput("time", testResult.executionTime);
     core.setOutput("succesful", testResult.succesful);
+    core.setOutput("reportUrl", testTrigger.reportUrl);
 
     // 4. Fail action if test failed
     if (!testResult.succesful) {
