Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aress31 authored Apr 9, 2023
1 parent 05045d5 commit de71703
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ To start using `burpgpt`, the user must first complete the following steps in th

After configuring the extension with the appropriate `API key`, `model`, and `prompt`, all passively scanned items will be analysed by the selected `OpenAI model` based on the configured settings. The results of the analysis will be displayed on a per-endpoint basis as an `Informational`-level finding.

<img src="https://user-images.githubusercontent.com/11601622/230777816-9f4c1e16-646f-4581-935f-e341f1323493.jpg" alt="burpgpt finding" width="75%" height="75%">

## Prompt Configuration

`burpgpt` allows users to customise the `prompt` for traffic-based analysis by using a system of `placeholders`. We recommend including the maximum relevant information in the prompt. The following `placeholders` are directly handled by the extension and can be used to dynamically insert specific values into the prompt:
Expand Down

0 comments on commit de71703

Please sign in to comment.