Update README.md
Changed some mistakes
This commit is contained in:
parent
3476a555c0
commit
299e3c909e
18
README.md
18
README.md
@ -1,6 +1,6 @@
|
|||||||
# synchronized-video-streaming
|
# synchronized-video-streaming
|
||||||
|
|
||||||
This project is a simple web application that allows users to watch videos together in real-time, ensuring a synchronized viewing experience. This project is built in Node.js, and utilizes Web-Sockets in order to send real time updated between the client and the server.
|
This project is a simple web application that allows users to watch videos together in real-time, ensuring a synchronized viewing experience. This project is built in Node.js, and utilizes Web-Sockets in order to send real time updates between the client and the server.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
* Real-time Synchronization: All participants are watching the same video at the same time, eliminating any delays or discrepancies.
|
* Real-time Synchronization: All participants are watching the same video at the same time, eliminating any delays or discrepancies.
|
||||||
@ -11,20 +11,22 @@ This project is a simple web application that allows users to watch videos toget
|
|||||||
|
|
||||||
|
|
||||||
## Installation & Usage
|
## Installation & Usage
|
||||||
1. Make sure Node.js is installed, if not visit [https://nodejs.org/en/download](https://nodejs.org/en/download)
|
1. Make sure Node.js is installed. If it isn't, visit [https://nodejs.org/en/download](https://nodejs.org/en/download)
|
||||||
2. Clone the repository ``` git clone https://github.com/ShakedAp/synchronized-video-streaming.git```
|
2. Clone the repository ``` git clone https://github.com/ShakedAp/synchronized-video-streaming.git```
|
||||||
3. Add your video to `/videos`, in `mp4` format
|
3. Add your video to `/videos`, in `mp4` format
|
||||||
4. Modify `settings.json`:
|
4. Modify `settings.json`:
|
||||||
- Set `ip` to your ip
|
- Set `ip` to your ip
|
||||||
- Set `port` to the host port (make sure it is unused)
|
- Set `port` to the host port (make sure it is unused)
|
||||||
- Set `video_path` to the path to your video: `videos/<yourvideo>.mp4`
|
- Set `video_path` to the path to your video: `videos/<yourvideo>.mp4`
|
||||||
- Set password to a string you like
|
- Set `password` to a string you like
|
||||||
5. Start the server: `npm start` or `node src/index.js`
|
5. Start the server: `npm start` or `node src/index.js`
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
4 Clients Synchronized:
|
4 Clients Synchronized (gif):
|
||||||

|

|
||||||
Login Page:
|
|
||||||

|
2 Clients Synchronized (gif):
|
||||||
2 Clients Synchronized:
|

|
||||||

|
|
||||||
|
The Login Page (img):
|
||||||
|

|
||||||
|
Loading…
x
Reference in New Issue
Block a user