feat: CORE-7413 - allow files to be relative paths or urls (#20)

feat: CORE-7413 - allow files to be relative paths or urls

BREAKING CHANGE: inputs have been renamed

.husky/pre-commit

@@ -1 +1,2 @@
 npm test
+npm run bundle

README.md

@@ -1,71 +1,7 @@
 # Corellium MATRIX
 
-This action runs the Corellium MATRIX solution.
+As part of our Business licenses, we offer an automated mobile application security testing tool referred to as MATRIX. The goal of MATRIX is to be a compelling and cost-effective DevSecOps solution. By harnessing the power of virtual devices, you can test your mobile applications on a wide range of devices without the need to purchase and maintain their physical counterparts.
 
-### Setup
+By building on the scalability and convenience of our cloud-based virtual devices, Corellium's MATRIX solution drastically reduces the effort, cost and time of penetration testing; enabling you to invest more into your security processes and ship more secure apps.
 
-This action requires the following repository secrets to be set up. For more information, see the GitHub's documentation for [Creating secrets for a repository](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).
-
-| Secret | Description |
-| ------ | ------ |
-| `CORELLIUM_API_TOKEN` | Corellium API token that can be created in our Web UI |
-| `CORELLIUM_PROJECT` | Corellium project ID |
-
-Create a workflow `.yml` file in your repository's `.github/workflows` directory. An example workflow can be found [here](#usage). For more information, see the GitHub's documentation for [Using workflows](https://docs.github.com/en/actions/using-workflows#creating-a-workflow-file).
-
-### Usage
-
-See [action.yml](https://github.com/corellium/matrix/blob/master/action.yml)
-
-Here's an example of how to use this action in a workflow file:
-
-```
-name: Run Corellium MATRIX solution
-
-on: [push]
-
-jobs:
-  corellium-matrix:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - run: npm ci
-      - run: npm run bundle
-
-      - name: Run MATRIX action
-        id: corellium-matrix
-        uses: ./
-        env:
-          PROJECT: ${{ secrets.CORELLIUM_PROJECT }}
-          API_TOKEN: ${{ secrets.CORELLIUM_API_TOKEN }}
-        with:
-          flavor: 'iphone14p'
-          os: '17.2'
-          server: 'https://app.corellium.com'
-          appUrl: 'https://www.corellium.com/hubfs/Corellium_Cafe.ipa'
-          inputUrl: 'https://www.somewebsite.com/inputs.json'
-
-      - run: echo "${{ steps.corellium-matrix.outputs.report }}"
-
-```
-
-### Inputs
-
-| Input | Description | Example | Required | Default |
-| ------ | ------ | ------ | ------ | ------ |
-| `server` | Specifies which Corellium server to use | <https://app.corellium.com> | false | <https://app.corellium.com> |
-| `flavor` | The flavor of the Instance that is being created | `iphone14p` | true | n/a |
-| `os` | The software version | `17.2` | true | n/a |
-| `appUrl` | URL to download test app | <https://www.corellium.com/hubfs/Corellium_Cafe.ipa> | true | n/a |
-| `inputUrl` | URL to download device input `.json` file. Examples can be found [here](https://app.corellium.com/api/docs#post-/v1/instances/-instanceId-/input) | <https://www.somewebsite.com/inputs.json> | true | n/a |
-| `wordlistUrl` | URL to download wordlist `.txt` file | <https://www.somewebsite.com/keywords.txt> | false | n/a |
-
-### Outputs
-
-| Output | Description |
-| ------ | ------ |
-| `report` | MATRIX report artifact download path relative to the Github workspace |
+[Learn more](https://support.corellium.com/features/matrix/) about MATRIX, or [get started](https://support.corellium.com/features/matrix/github-action) with our GitHub Action!