diff --git a/README.md b/README.md index 7cfa179..dd01ca0 100644 --- a/README.md +++ b/README.md @@ -1 +1,75 @@ -# Sky-Now +# Sky Now + +Sky Now is a web application that provides real-time weather updates based on your current location. It gives you detailed weather information including temperature, humidity, wind speed, and more. + +## Table of Contents + +- [Features](#features) +- [Live Demo](#live-demo) +- [Installation](#installation) +- [Usage](#usage) +- [Technologies Used](#technologies-used) +- [Contributing](#contributing) +- [License](#license) + +## Features + +- Real-time weather updates +- User-friendly interface +- Detailed weather information +- Supports multiple weather parameters like temperature, humidity, wind speed, etc. +- Easy access to weather data for the current location + +## Live Demo + +Check out the live demo [here](https://amit712singhal.github.io/Sky-Now/#/current-location). + +## Installation + +To run this project locally, follow these steps: + +1. **Clone the repository** + + ```sh + git clone https://github.com/amit712singhal/Sky-Now.git + cd Sky-Now + ``` + +2. **Open index.html in your web browser** + + You can either open the index.html file directly in your browser or use a local server like [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) in VSCode to serve the files. + +## Usage + +1. **Grant location permission** + + Once you've opened the application, it will request access to your device's location. Grant permission by clicking "Allow" or "Grant Access". + +2. **View current weather** + + After granting permission, the application will display the current weather information for your location, including temperature, humidity, wind speed, and more. + +3. **Search for weather updates** + + To view the weather for a different location, enter the location name or city in the search bar and press Enter. The application will fetch and display the weather information for the searched location. + +## Technologies Used + +- HTML5: For structuring the web content +- CSS3: For styling the web content +- JavaScript: For making the web content interactive +- OpenWeatherMap API: For fetching real-time weather data + +## Contributing + +Contributions to this project are welcome! If you find any bugs or have suggestions for improvements, please create an issue or submit a pull request. + +1. Fork the repository. +2. Create your feature branch (`git checkout -b feature/YourFeature`). +3. Commit your changes (`git commit -am 'Add some feature'`). +4. Push to the branch (`git push origin feature/YourFeature`). +5. Create a new Pull Request. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.