From d733d70d755975e6e0de692642b170eb1922d506 Mon Sep 17 00:00:00 2001 From: daniel Date: Wed, 18 Sep 2024 18:06:22 +0000 Subject: [PATCH] Update README.md --- README.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index bc8e2fa..54c8993 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ This Bash script helps you identify which assets in your AWS Route53 hosted zone **Setup** --------- -1. **Create a .env file:** In the same directory as the script, create a file named .env with the following content: +**Create a .env file:** In the same directory as the script, create a file named .env with the following content: Replace the placeholders with your actual AWS profile name, JupiterOne API key, and JupiterOne account ID. ``` AWS_PROFILE=your_aws_profile_name @@ -37,12 +37,12 @@ J1_ACCOUNT=your_jupiterone_account\id **Usage** --------- -1. **Make the script executable: +1. Make the script executable: ```bash chmod +x dangle.sh ``` -2. **Run the script: +2. Run the script: ```bash ./dangle.sh or @@ -59,13 +59,4 @@ The script will output the DNS records and whether or not a corresponding asset * **Additional Record Types:** Currently the script only handles A and CNAME records. We should extend it to support other record types like MX, TXT, etc. -* **JupiterOne Query:** The JupiterOne query is currently VERY simple. We might want to refine it. - - -**Remember:** - -* Replace script\_name.sh with the actual filename of your script. - -* Ensure the .env file is in the same directory as the script. - -* Consider adding more details to the README, such as examples of the output, potential use cases, or troubleshooting tips. \ No newline at end of file +* **JupiterOne Query:** The JupiterOne query is currently VERY simple. We might want to refine it. \ No newline at end of file