Skip to content

Commit a87426f

Browse files
committed
Update root readme with images
1 parent d018387 commit a87426f

File tree

5 files changed

+9
-2
lines changed

5 files changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,22 @@ file-sync/
4141
│ │ ├── App.js # Main React component
4242
│ │ └── components/ # UI components for specific pages and functionalities
4343
│ │ ├── SenderPage.js # Component for the sender page
44-
│ │ └── ReceiverPage.js # Component for the receiver page
44+
│ │ ├── ReceiverPage.js # Component for the receiver page
45+
│ │ ├── UploadPage.js # Component for S3 file upload
46+
│ │ └── DownloadPage.js # Component for S3 file download
4547
│ └── package.json # React project dependencies and scripts
4648
├── .gitignore # Root .gitignore
4749
└── README.md # Project overview and setup instructions
4850
```
4951

50-
## Sender and Receiver Pages
52+
## Sender, Receiver, Upload, and Download Pages
5153

5254
| ![Sender Page](https://github.com/eomielan/file-sync/blob/main/images/sender.png?raw=true) | ![Receiver Page](https://github.com/eomielan/file-sync/blob/main/images/receiver.png?raw=true) |
5355
| :----------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------: |
5456

57+
| ![Upload Page](https://github.com/eomielan/file-sync/blob/main/images/upload.png?raw=true) | ![Download Page](https://github.com/eomielan/file-sync/blob/main/images/download.png?raw=true) |
58+
| :----------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------: |
59+
5560
## Getting Started
5661

5762
This project requires **Node.js** for the frontend, **Java 17** with **Gradle** for the backend, and **GCC** to compile the C binaries for TCP-like functionality over UDP.
@@ -149,6 +154,8 @@ For detailed frontend setup and usage, see the [frontend README](frontend/README
149154

150155
1. **Sender**: Access the "Sender" page in the React app, where you can specify the file, receiver hostname, port, and byte transfer limit.
151156
2. **Receiver**: Access the "Receiver" page to enter the port, desired filename, and file storage location, then start the receiver process.
157+
3. **Upload to S3**: Navigate to the "Upload" page, select a file, enter the bucket name and desired file name, then upload it to S3.
158+
4. **Download from S3**: Access the "Download" page to specify the bucket name and file name, and download the file from S3.
152159

153160
## Additional Resources
154161

images/download.png

109 KB
Loading

images/receiver.png

5.12 KB
Loading

images/sender.png

4.93 KB
Loading

images/upload.png

116 KB
Loading

0 commit comments

Comments
 (0)