Canstralian commited on
Commit
0cf65fc
1 Parent(s): cb2b313

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -1
README.md CHANGED
@@ -10,4 +10,43 @@ pinned: false
10
  license: mit
11
  ---
12
 
13
- An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: mit
11
  ---
12
 
13
+ # Bug Bot 💬
14
+
15
+ Bug Bot is an AI-powered chatbot designed to assist security researchers and ethical hackers with bug bounty hunting. It provides real-time support for technical queries, offering guidance on penetration testing, vulnerability assessment, and other related tasks. Whether you're a beginner or an experienced professional, Bug Bot is here to help you navigate the bug bounty landscape!
16
+
17
+ ### Features:
18
+ - **Bug Bounty Assistance**: Provides advice and technical support for bug bounty hunting.
19
+ - **Security Insights**: Answers technical questions related to penetration testing, network security, and ethical hacking.
20
+ - **Penetration Testing Tools**: Offers suggestions and solutions for penetration testing challenges.
21
+ - **Real-Time Responses**: Uses advanced AI to respond quickly and accurately to your queries.
22
+
23
+ ## How to Use
24
+
25
+ 1. Clone the repository to your local machine:
26
+ ```bash
27
+ git clone https://github.com/<your-username>/bug-bot.git
28
+ cd bug-bot
29
+ ```
30
+
31
+ 2. Install dependencies:
32
+ ```bash
33
+ pip install -r requirements.txt
34
+ ```
35
+
36
+ 3. Run the app:
37
+ ```bash
38
+ python app.py
39
+ ```
40
+
41
+ 4. Open the browser and navigate to `http://localhost:7860` to interact with Bug Bot.
42
+
43
+ ## Customization
44
+
45
+ You can customize the system message and settings in the `app.py` file, particularly the following section:
46
+ ```python
47
+ gr.Textbox(value="You are a chatbot trained to assist with specific tasks in bug bounty hunting, offering advice on penetration testing, vulnerability discovery, and other security-related topics.", label="System message")
48
+
49
+ License
50
+
51
+ This project is licensed under the MIT License - see the LICENSE file for details.
52
+