Skip to content

Commit 79b6f58

Browse files
committed
Update README with new features and installation options
Expanded the feature list to include text sharing, clickable/copyable server URL, mobile optimization, and improved system tray access. Added detailed installation instructions for installer, portable build, and running from source. Updated project directory structure to reflect new files and organization.
1 parent 2e0122b commit 79b6f58

1 file changed

Lines changed: 35 additions & 5 deletions

File tree

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,27 @@ WebShare for Windows is a file-sharing application that utilizes PySide6 (Qt6) f
66

77
### Core Features
88
- **Local File Sharing**: Upload files from your PC and share them with other devices on the network.
9+
- **Text Sharing**: Share text snippets easily with clipboard support.
910
- **QR Code Generation**: Automatically generates a QR code for easy access to the server URL.
10-
- **Dark Mode UI**: A modern, visually appealing interface.
11+
- **Dark Mode UI**: A modern, visually appealing interface with mobile-responsive design.
1112
- **File Upload & Download**: List and download files from the web interface.
1213
- **File Management**: Delete files from the web interface or application.
1314
- **Storage Statistics**: Track file count and storage usage.
1415
- **Upload Progress**: Visual feedback during file uploads.
1516
- **Customizable Port**: Configure the server port as needed.
1617
- **About Dialog**: View information about the application.
1718
- **Update Checker**: Check for and download new versions of the application.
19+
- **Clickable URL**: Click the server URL to open it in your browser.
20+
- **Copy to Clipboard**: Easily copy the server URL with one click.
1821

1922
### Advanced Features
2023
- **Password Protection**: Secure your server with optional password authentication
2124
- **Multiple File Upload**: Upload multiple files at once with batch processing
2225
- **Drag & Drop**: Drag files directly from your desktop into the browser
2326
- **File Preview**: Preview images, text files, and PDFs without downloading
24-
- **System Tray**: Minimize to system tray with quick server control
27+
- **System Tray**: Minimize to system tray with quick access to uploads folder
2528
- **Enhanced Progress**: Real-time progress tracking for multiple file uploads
29+
- **Mobile Optimized**: Responsive web interface works great on phones and tablets
2630

2731
### Security & Performance
2832
- **File Upload Limits**: Configurable maximum file size (default 500 MB) and total storage (default 10 GB)
@@ -41,6 +45,22 @@ WebShare for Windows is a file-sharing application that utilizes PySide6 (Qt6) f
4145

4246
## 💻 Installation & Usage
4347

48+
### Option 1: Download Installer (Recommended)
49+
50+
1. Download the latest installer from the [Releases page](https://github.com/oop7/WebShare-for-Windows/releases)
51+
2. Run the installer and follow the setup wizard
52+
3. Launch WebShare from the Start Menu or Desktop shortcut
53+
54+
### Option 2: Download Portable Build
55+
56+
1. Download the latest release ZIP file from the [Releases page](https://github.com/oop7/WebShare-for-Windows/releases)
57+
2. Extract the ZIP file to your desired location
58+
3. Run `WebShare.exe`
59+
60+
No Python installation required for either option!
61+
62+
### Option 3: Run from Source
63+
4464
1. Clone this repository:
4565
```bash
4666
git clone https://github.com/oop7/WebShare-for-Windows.git
@@ -110,29 +130,39 @@ Logs are stored in the `logs/` directory with automatic rotation.
110130

111131
```
112132
WebShare-for-Windows/
133+
├── .github/ # GitHub Actions
134+
│ └── workflows/
135+
│ └── build-windows.yml # Automated build workflow
113136
├── app/ # Application package
114137
│ ├── templates/ # HTML templates
115-
│ │ ├── icon/ # Application icons
116-
│ │ └── index.html # Web interface
138+
│ │ ├── icon/ # Application icons (icon.ico, icon.png, icon48.png)
139+
│ │ ├── index.html # Web interface
140+
│ │ └── login.html # Login page
117141
│ ├── utils/ # Utility functions
118142
│ │ ├── icon_fallback.py
119143
│ │ ├── network.py
120144
│ │ └── qr_helper.py
121145
│ ├── __init__.py # Package initialization
146+
│ ├── auth.py # Authentication system
122147
│ ├── config.py # Configuration management
148+
│ ├── file_ops.py # File operations
123149
│ ├── file_validator.py # File validation and security
124150
│ ├── gui.py # PySide6 GUI implementation
125151
│ ├── logger.py # Logging system
152+
│ ├── routes.py # Flask routes
126153
│ ├── server.py # Flask server implementation
154+
│ ├── settings_dialog.py # Settings dialog
127155
│ └── version.py # Version information
128156
├── logs/ # Log files directory
157+
├── temp/ # Temporary files directory
129158
├── uploads/ # Default upload directory
130159
├── .gitignore # Git ignore file
131160
├── config.json # Configuration file (auto-generated)
132161
├── LICENSE # MIT License
133162
├── main.py # Main application entry point
163+
├── pytest.ini # Pytest configuration
134164
├── README.md # Project documentation
135-
── requirements.txt # Python dependencies
165+
── requirements.txt # Python dependencies
136166
```
137167

138168
## 📜 License

0 commit comments

Comments
 (0)