Update README.md

README.md

@@ -9,4 +9,28 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# GPT Vulnerability Analyzer
+
+This is a Proof Of Concept application demonstrating how AI can be used for vulnerability analysis. The project integrates with OpenAI API, Bard API, and other tools for network vulnerability analysis, DNS enumeration, and subdomain enumeration.
+
+## Requirements
+
+- Python 3.10 or above
+- All packages mentioned in `requirements.txt`
+- OpenAI API
+- Bard API (MakerSuite Palm)
+- Runpod serverless endpoint
+- IPGeolocation API
+- Docker
+- Wireshark and tshark
+
+## Usage
+
+### Package Installation
+
+Install the package by navigating to the package directory and running:
+
+```bash
+cd package
+pip install .