Update README.md

This commit is contained in:
Bently 2024-06-27 19:27:19 +00:00
parent 5d8d61837d
commit b356a4b5a8

View file

@ -1,3 +1,58 @@
# SendIt
# SendIt: Secure Direct File Sharing
SendIt file-sharing!
**SendIt** offers a secure, serverless method to directly share files between users, facilitated by WebSockets. This Python Flask-based application ensures files are transferred peer-to-peer without ever being stored on a server, preserving privacy and reducing dependency on cloud storage.
## Features
- **Direct Peer-to-Peer Transfers:** Utilizes WebSockets for real-time, direct file sharing without server storage.
- **Temporary Transfer Codes:** Generates temporary codes for file transfers, which expire after 10 minutes to secure each transaction.
- **Real-Time Notifications:** Updates senders and receivers about file status, including download progress and time until expiry.
- **Web Interface:** Simple, intuitive web-based interface for easy file transfers from any modern browser.
## Technologies
- **Backend:** Python Flask with Flask-SocketIO for handling WebSocket connections.
- **Frontend:** HTML5, CSS3, and Vanilla JavaScript for a dynamic user experience.
## Installation and Setup
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/SendIt.git
cd SendIt/SendIt
```
2. **Install dependencies:**
```bash
pip install Flask Flask-SocketIO
```
3. **Run the application:**
```bash
python app.py
```
## Usage
- **Uploading a File:** Drag and drop a file into the web interface or click to select a file. A unique code will be generated.
- **Downloading a File:** Enter the code received from the sender to begin the direct download.
## Workflow
```mermaid
sequenceDiagram
participant Sender
participant WebInterface
participant Receiver
Sender->>WebInterface: Starts file upload
WebInterface->>Sender: Provide unique code
Sender->>Receiver: Share unique code
Receiver->>WebInterface: Enter unique code
WebInterface->>Sender: Notify file ready for download
Sender->>Receiver: Transfer file directly
Receiver->>Sender: Notify file received
Receiver->>WebInterface: Transfer completed
Note right of WebInterface: Once file transfer is completed, the connection is closed and resources are cleaned up.
```
# Contributing
Contributions to enhance functionality, improve design, or fix bugs are always welcome. Please fork the repository, make your changes, and submit a pull request.