From 4ee0cf828569585c559d9efd92258f5bf40ea1e4 Mon Sep 17 00:00:00 2001
From: Chloe Lin <55333255+Chloe2330@users.noreply.github.com>
Date: Wed, 8 May 2024 10:16:06 -0700
Subject: [PATCH] Create README.md

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

diff --git a/yaml_runner/README.md b/yaml_runner/README.md
new file mode 100644
index 0000000..eac8998
--- /dev/null
+++ b/yaml_runner/README.md
@@ -0,0 +1,8 @@
+# Running Vignesh's scripts
+
+1. Running the github_workflow_analysis:
+For running this script, just have modules requests and Beautiful Soup installed, edit the entry file name and exit file name from default and run it using Python.
+2. Running the yaml_checker:
+Edit the name of input and output file and put in a valid Github token. It takes an list of excel url's and generates a list with column ascertaining which have dependabot and workflow files.
+3. Running private_advisory_checker:
+Just change the input name of file and output file and also have Chrome installed on device. Also install modules selenium and webdriver_manager. Besides that enter your login details for Github to run in.