From ac762c9aef02b827356a8acf420718c1e6a00709 Mon Sep 17 00:00:00 2001 From: Carlos Matos Date: Tue, 10 Oct 2023 13:42:07 +0000 Subject: [PATCH 1/2] docs: updated readme to include python deps --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 4b852c0..d0011dd 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,24 @@ To install as a container: git clone https://github.com/CrowdStrike/falcon-integration-gateway.git ``` +1. Install the python dependencies. + + You can either use the `requirements.txt` file: + + ```shell + pip install -r requirements.txt + ``` + + or install the individual python packages associated with your backend: + + > Example: AWS backend + + ```shell + pip install crowdstrike-falconpy boto3 + ``` + 1. Modify the `./config/config.ini` file with your backend options + 1. Run the application ```bash From 29afa60d8c49ff0aa53583320650665dbe85f73d Mon Sep 17 00:00:00 2001 From: Carlos Matos Date: Wed, 18 Oct 2023 10:04:32 -0400 Subject: [PATCH 2/2] chore: update pip install instructions to be clearer --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d0011dd..46b39ad 100644 --- a/README.md +++ b/README.md @@ -78,22 +78,12 @@ To install as a container: git clone https://github.com/CrowdStrike/falcon-integration-gateway.git ``` -1. Install the python dependencies. +1. Install the python dependencies. - You can either use the `requirements.txt` file: - - ```shell + ```bash pip install -r requirements.txt ``` - or install the individual python packages associated with your backend: - - > Example: AWS backend - - ```shell - pip install crowdstrike-falconpy boto3 - ``` - 1. Modify the `./config/config.ini` file with your backend options 1. Run the application