From cd809310118eed9ac343c51dd8e220dc5326b25f Mon Sep 17 00:00:00 2001
From: Klaus Hartl <klaus.hartl@gmail.com>
Date: Sun, 19 Sep 2021 08:25:13 +0200
Subject: [PATCH] Add readme

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0d723b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Detect secrets with Talisman action
+
+This action uses [Talisman](https://thoughtworks.github.io/talisman/) to scan the incoming (pushed) range of commits for accidentally added secrets and sensitive information. It mimics a pre-push hook for this, thus it works nicely with a local git hook in tandem, that is as a fallback, last line of defense.
+
+## Example usage
+
+```yml
+uses: carhartl/talisman-secrets-scan-action@v1
+```