From c95c85f1262e398710c9d3d71002945a38d9d2ff Mon Sep 17 00:00:00 2001
From: Eric Brown <ericwb@users.noreply.github.com>
Date: Sat, 9 Mar 2024 19:32:50 -0800
Subject: [PATCH] Fill out the README with details

* Add usage example
* Add details of the inputs

Signed-off-by: Eric Brown <ericwb@users.noreply.github.com>
---
 README.md | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a37b83e..47b0ec5 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,41 @@
-# precli-action
\ No newline at end of file
+# Precaution Analysis Action
+
+Analyze your source code using Precaution via [precli](https://github.com/securesauce/precli).
+
+## Usage
+
+Here is a minimal complete example to create a Code Scanning action using Precaution.
+
+```yaml
+name: Precaution
+
+on:
+  workflow_dispatch:
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    permissions:
+      # required for all workflows
+      security-events: write
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+    steps:
+      - name: Perform Precaution Analysis
+        uses: securesauce/precli-action@v1
+```
+
+## Inputs
+
+### `path`
+
+**Optional** The source file(s) or directory(s) to be analyzed
+
+**Default** `"."`
+
+### `disable`
+
+**Optional** A comma-separated list of rule IDs or names to disable
+
+**Default** `"DEFAULT"`