From 405bf39326fbef356a88a6875032064123b95a25 Mon Sep 17 00:00:00 2001
From: Rostislav Raykov <rostislav.raykov@infinno.eu>
Date: Sun, 6 Oct 2024 00:49:10 +0300
Subject: [PATCH] update to the README.md

---
 README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..10d4990
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# QuickDrop
+
+QuickDrop is a secure, easy-to-use file sharing application that allows users to upload files without an account, generate download links, and manage file availability, all with built-in malware scanning and optional password protection.
+
+## Features
+
+- **File Upload**: Users can upload files without needing to create an account.
+- **Download Links**: Generate download links for easy sharing.
+- **File Management**: Manage file availability with options to keep files indefinitely or delete them.
+- **Malware Scanning**: Built-in malware scanning to ensure file safety.
+- **Password Protection**: Optionally protect files with a password.
+
+## Technologies Used
+
+- **Java**
+- **Spring Boot**
+- **Maven**
+- **Thymeleaf**
+- **SQLite**
+
+## Getting Started
+
+### Prerequisites
+
+- Java 11 or higher
+- Maven
+- SQLite
+
+### Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/RoastSlav/quickdrop.git
+    cd quickdrop
+    ```
+
+2. Configure the file save path in `src/main/resources/application.properties`:
+    ```ini
+    file.save.path=/path/to/save/files
+    ```
+
+3. Build the project using Maven:
+    ```sh
+    mvn clean install
+    ```
+
+4. Run the application:
+    ```sh
+    mvn spring-boot:run
+    ```
+
+### Usage
+
+- Access the application at `http://localhost:8080`.
+- Use the upload page to upload files.
+- Manage files and generate download links from the file list page.
+
+## Contributing
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Make your changes.
+4. Commit your changes (`git commit -m 'Add some feature'`).
+5. Push to the branch (`git push origin feature-branch`).
+6. Open a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.
\ No newline at end of file