Readme

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š