From d1059c4dd5e6bee0e81028ac9839eef9b8beed4d Mon Sep 17 00:00:00 2001
From: Erik Sierra <120680439+ErikSierra@users.noreply.github.com>
Date: Mon, 17 Jun 2024 09:51:25 -0400
Subject: [PATCH] Create README.md

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

diff --git a/FalconTests/README.md b/FalconTests/README.md
new file mode 100644
index 0000000..0b631ec
--- /dev/null
+++ b/FalconTests/README.md
@@ -0,0 +1,25 @@
+## Falcon Tests
+
+These files are used only for testing the functionality of the FalconContainment process. Each .py tests different parts of the process in order to minimize errors during official use.
+
+### APIconnectionTest.py
+
+This script is designed to test the connection to the Crowdstrike API and to read hosts provided in the computers.txt file.
+
+#### Usage
+
+1. Install the necessary packages by running the following prompt in your terminal
+pip install -r requirements.txt
+
+
+2. Use the config.yaml file and insert your API credentials and the file path to the computers.txt file. The file should be structured as follows:
+api: client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET file_path: computers.txt
+
+
+3. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
+python APIconnectionTest.py
+
+
+*** Please note that this script is for testing purposes only and should not be used for any official API containment within Crowdstrike Falcon or related resources. Use 'Containment.py' for Crowdstrike API containment. Refer to the GitHub repository for instructions.***
+
+For details on the functions within the script, please refer to the comments within the code.