From 09cfd36367ba44e26889b06d554cd26a3953f7d3 Mon Sep 17 00:00:00 2001
From: Jingchao Zhong <92573736+perryzjc@users.noreply.github.com>
Date: Thu, 8 Jun 2023 03:21:22 -0700
Subject: [PATCH] Update README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 293cffb..28d1949 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,30 @@
-# detect-secrets-action
-About A robust GitHub Action that scans your repository for any accidentally committed secrets, bolstering your codebase's security and minimizing risk.
+# detect-secrets Action
+
+detect-secrets Action is a powerful GitHub Action designed to scan your repository for any secrets that may have been accidentally committed, helping to protect your codebase and minimize the risk of sensitive information leakage. It is built upon the experimental version of `slim-detect-secrets` from NASA AMMOS and will be updated to use the official Yelp/detect-secrets version once the customized plugins are merged.
+
+For detailed information about `slim/detect-secrets`, please refer to the following links:
+1. [Experimental version of slim-detect-secrets (with additional secret detection plugins)](https://github.com/NASA-AMMOS/slim-detect-secrets/tree/exp)
+2. [SLIM's documentation for detect-secrets usage](https://github.com/NASA-AMMOS/slim/blob/d20ee6134a0dc0e0dab11d2d2570e358ef7e4550/continuous-testing/starter-kits/README.md#detect-secrets)
+
+## Usage
+
+To integrate the Detect Secrets Action into your workflow, include the following configuration in your GitHub Actions workflow file:
+
+[View the action.yml configuration](https://github.com/perryzjc/slim-detect-secrets-action/blob/main/action.yaml)
+
+## Workflow Steps
+
+The Detect Secrets Action follows these steps to ensure the security of your code:
+
+1. **Checkout Code**: Utilizes GitHub's checkout action to access the repository. This is the code that will be scanned for secrets.
+2. **Install Necessary Packages**: Deploys the required Python packages, including the experimental version of `slim-detect-secrets` and `jq`. These packages enable the primary functionality of the Action.
+3. **Check Existence of .secrets.baseline**: Ensures the Action remains operational even if no baseline file exists yet. If the `.secrets.baseline` file is not found, the action creates an initial baseline file by scanning an empty directory.
+4. **Scan Repository for Secrets**: In this step, the Action backs up the list of known secrets and scans the repository for any new secrets. The scan excludes files starting with '.secrets.' and '.git'. The 'compare_secrets' function is used to identify any differences between the known secrets and newly detected ones. If new secrets are detected, the build fails, and the user is guided to clean up the secrets using the `detect-secrets` tool.
+
+## Support
+
+Should you encounter any issues or require further assistance, feel free to create an issue in this repository. We value your feedback and will strive to provide timely support.
+
+## Contributing
+
+We warmly welcome contributions to the Detect Secrets Action. If you have an idea for an improvement or have discovered a bug, please fork this repository, make your changes, and submit a pull request. We appreciate your efforts in helping us make this action better!