From ebd7fe6b14c3b960b178567841ef37a587f7a827 Mon Sep 17 00:00:00 2001 From: Dominik Date: Thu, 13 Nov 2025 19:22:34 +0100 Subject: [PATCH] Readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index e69de29..fe49a9d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# Introduction + +FileLeak is a minimal Firefox browser extension that enables the user to run continuous or one-off scans on connected websites to detect hidden files that should not be publicly accessible. + +## Functionality + +This is a Proof-of-Concept, not a final application. Use at your own risk. Scanning for unauthorized files, and especially accessing them, even **if** they are publicly hosted, may be illegal in your country. +# Requirements + +Tested on: \ +Mozilla Firefox 145.0+ + +# Build + +If you want to develop or test use Mozilla [web-ext](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/). Once installed, run: +```bash +make run +``` +This executes the `start:firefox` script inside `package.json` and opens a new instance of Firefox with the extension loaded. + +# Author + +Dominik Agreš