Merge pull request #1 from TomLefley/main

README updates

Author: Hannah-PortSwigger

.github/workflows/build.yml

@@ -0,0 +1,67 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Java CI with Gradle
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 21
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+
+    # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
+    # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
+    - name: Setup Gradle
+      uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+
+    - name: Build with Gradle Wrapper
+      run: ./gradlew build
+
+    # NOTE: The Gradle Wrapper is the default and recommended way to run Gradle (https://docs.gradle.org/current/userguide/gradle_wrapper.html).
+    # If your project does not have the Gradle Wrapper configured, you can use the following configuration to run Gradle with a specified version.
+    #
+    # - name: Setup Gradle
+    #   uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+    #   with:
+    #     gradle-version: '8.9'
+    #
+    # - name: Build with Gradle 8.9
+    #   run: gradle build
+
+  dependency-submission:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK 21
+      uses: actions/setup-java@v4
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+
+    # Generates and submits a dependency graph, enabling Dependabot Alerts for all project dependencies.
+    # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
+    - name: Generate and submit dependency graph
+      uses: gradle/actions/dependency-submission@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0

README.md

@@ -1,17 +1,32 @@
 # ReportLM – AI-Powered Reporting for Burp Suite
 
-**ReportLM** is a Burp Suite extension that leverages [Burp AI](https://portswigger.net/burp/documentation/desktop/extensions/using-ai-extensions) to generate custom reports from issues identified by Burp Scanner. This tool streamlines the reporting process, allowing users to curate issues, apply custom specifications, and generate comprehensive reports with AI assistance.
+**ReportLM** is a Burp Suite extension that enhances the reporting process by leveraging **[Burp AI](https://portswigger.net/burp/documentation/desktop/extensions/using-ai-extensions)** to generate custom reports from issues identified by **Burp Scanner**. This tool allows users to **curate findings, define report specifications, and produce comprehensive, AI-assisted reports** tailored to their needs.
+
+By integrating **Burp AI**, **ReportLM** enables a high degree of customisation, allowing reports to be adapted to different audiences or requirements. Users can adjust tone, technical depth, and language to suit the reader’s **experience level, role, or preferred format**. This flexibility makes it easier to generate reports that are clear, relevant, and aligned with specific use cases.
+
+---
+
+## 💡 How It Works
+
+1.	**Issue Processing** – ReportLM extracts issue details, background, and remediation information from Burp Scanner.
+2.	**Customisation Options** – Users can specify custom requirements, such as tone, audience, format, or language preferences.
+3.	**AI-Powered Generation** – The gathered data is sent to Burp AI, which generates the report. 
+      - Depending on the generation mode, the report will be returned all at once or section by section.
+4.	**Post-Processing** – Once the report is generated:
+      - If generated in sections, the details are combined into a final, complete report.
+      - Evidence (e.g., request/response pairs) is then attached if enabled.
+5.	**Transparency & Logging** – All data sent to Burp AI can be traced using the logging settings for visibility and peace of mind.
 
 ## 🔧 Usage
 
-1. **Add Issues** – Right-click on any issue and select "Add to ReportLM."
+1. **Add Issues** – Right-click on any issue and select "ReportLM", "Add to report".
 2. **Review & Edit** – Check the report table and remove any unwanted issues.
 3. **Customize** – Enter any specific details required for the report.
 4. **Generate** – Click the "Generate" button and let Burp AI create a detailed report for you.
 
 ## 📥 Installation
 
-1. Install **ReportLM** via the Burp Suite **BApp Store** (if available) or manually from the [Releases](https://github.com/TomLefley/report-lm/releases).
+1. Install **ReportLM** via the Burp Suite **[BApp Store](https://portswigger.com/bappstore/c29264074acc4aacb5b424e6a033ba5d)** (if available) or manually from the [Releases](https://github.com/TomLefley/report-lm/releases).
 2. Ensure AI is enabled for the extension in Burp Suite settings.
 
 ## 🤝 Contributing