From 7d24d5abeba22f40b7a74b1f60e71fd8d53373f6 Mon Sep 17 00:00:00 2001
From: Ian Woodard <17186604+IanWoodard@users.noreply.github.com>
Date: Tue, 2 Apr 2024 16:02:32 -0700
Subject: [PATCH] Beginning to update readme

---
 README.md  | 39 ++++++++++++++++++++++++++++++++++++++-
 action.yml |  4 ++--
 2 files changed, 40 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 1c7bfab..9e2323d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
-# action-collect-test-data
\ No newline at end of file
+action-collect-test-data
+=========================
+
+This action collects test output data and metadata from the GitHub Actions
+environment and uploads it to a Google Cloud Storage bucket.
+
+### Inputs
+
+- `path` (required): Path to the test output file.
+- `gcs_path` (required): Path to the GCS bucket where the test data will be uploaded.
+- `gcp_project_id` (required): GCP project ID.
+- `workload_identity_provider` (required): Workload Identity Provider.
+- `service_account_email` (required): Service Account Email.
+
+### Outputs
+
+- `uploaded`: The list of files uploaded to GCS.
+
+### Usage
+
+```yaml
+steps:
+- name: Checkout
+  uses: actions/checkout@v4
+
+- name: Run tests
+  run: echo "Run tests and generate an output file"
+
+- name: Collect test data
+  if: '!cancelled()' # Always run this step, unless the workflow was cancelled
+  uses: getsentry/action-collect-test-data@v0.1.0
+  with:
+    path: <path to test output file>
+    gcs_path: <path to GCS bucket> # Can include an optional prefix
+    gcp_project_id: <GCP project ID>
+    workload_identity_provider: <Workload Identity Provider>
+    service_account_email: <Service Account Email>
+```
diff --git a/action.yml b/action.yml
index 9618a8d..a9dabd8 100644
--- a/action.yml
+++ b/action.yml
@@ -2,10 +2,10 @@ name: 'Collect Test Data'
 description: 'Collect test data and metadata and upload them to GCS.'
 inputs:
   path:
-    description: 'The path to the JUnit XML file to be processed.'
+    description: 'The path to the test output (such as a JUnit XML file).'
     required: true
   gcs_path:
-    description: 'The GCS bucket and optional prefix to upload the JUnit XML and metadata files to.'
+    description: 'The GCS bucket and optional prefix to upload the test data and metadata to.'
     required: true
   gcp_project_id:
     description: 'The GCP project ID to use for authentication.'