diff --git a/README.md b/README.md index 19591fd..ce545a9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,53 @@ -# hey_stranger_frontend -Frontend for Hey stranger +# Hey Stranger Frontend + +Welcome to the frontend repository for the Hey Stranger application. + + + +## Introduction +Hey Stranger is a web application designed to connect people from around the world. This repository contains the frontend code built with modern web technologies. +## Features + +- Real-time chat +- Chat with interests +- Video chat with interests + +## Technologies Used +- WebRTC +- Socket.io + +## Installation +To get started with the project, clone the repository and install the dependencies: + +```bash +git clone https://github.com/yourusername/heyStranger_frontend.git +cd heyStranger_frontend +``` + + + +## Usage + +To start the development server, use the Live Server extension and navigate to `http://localhost:5500`. + +## Output +![ChatScreens](./img/chat-output.png) + +## Contributing +We welcome contributions! Please read our [contributing guidelines](CONTRIBUTING.md) for more details. + +## License +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. + +