mirror of
https://github.com/hmalik144/Weather-apps.git
synced 2025-12-10 02:05:20 +00:00
Readme and screenshot (#35)
- atlas weather notification fix (only for lower versions) - Minor lint fixes - Upgrade gradle dependencies to versions accepted by android 33 - upgrade android gradle to 8.5 - upgrade application to android 34 - upgraded all library dependencies - readme.md added - Snapshot tests added for readme.md - UI corrections during snapshots
This commit is contained in:
64
readme.md
Normal file
64
readme.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Weather-apps
|
||||
|
||||
Weather-apps contains two weather apps - Atlas weather and Mono weather. They are both simple and user-friendly Android applications that provides current weather information and forecasts. With a sleek design and accurate data, to keeps you updated on the latest weather conditions in your area.
|
||||
|
||||
## Features
|
||||
|
||||
- **Current Weather**: Get real-time weather updates including temperature, humidity, wind speed, and atmospheric pressure.
|
||||
- **Forecast**: View detailed weather forecasts for the next 7 days.
|
||||
- **Location-Based Updates**: Automatically fetch weather data based on your current location.
|
||||
- **Search Functionality**: Search for weather information in different cities around the world.
|
||||
- **Notifications**: Receive weather alerts and notifications for significant weather changes.
|
||||
- **Customizable Settings**: Choose between Celsius and Fahrenheit, and set your preferred update frequency.
|
||||
- **Customizable Home screen widget**: Add a home screen widget to give you regular updates on forecast.
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Atlas Weather
|
||||

|
||||

|
||||

|
||||
### Mono Weather
|
||||

|
||||

|
||||

|
||||
|
||||
## Usage
|
||||
|
||||
1. Upon launching the app, you will be prompted to allow location access. Grant the necessary permissions.
|
||||
2. The home screen will display the current weather information for your location.
|
||||
3. Swipe left or tap on the forecast tab to view the 7-day weather forecast.
|
||||
4. Use the search icon to look up weather information for other cities.
|
||||
5. Access the settings menu to customize your preferences.
|
||||
|
||||
## Permissions
|
||||
|
||||
The app requires the following permissions:
|
||||
|
||||
- **Location**: To provide accurate weather information based on your current location.
|
||||
- **Internet**: To fetch weather data from the server.
|
||||
|
||||
## API
|
||||
|
||||
Weather-apps
|
||||
- uses the [OpenWeatherMap API](https://openweathermap.org/api) to retrieve weather data.
|
||||
- uses the [TomTom Search API](https://developer.tomtom.com/search-api/documentation/product-information/introduction) to retrieve geolocation data.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please follow these steps:
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a new branch: `git checkout -b feature/your-feature-name`
|
||||
3. Make your changes and commit them: `git commit -m 'Add some feature'`
|
||||
4. Push to the branch: `git push origin feature/your-feature-name`
|
||||
5. Create a pull request.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- [OpenWeatherMap](https://openweathermap.org) for the weather data API.
|
||||
- [TomTom Search API](https://developer.tomtom.com/search-api/documentation/product-information/introduction) for the geolocation API.
|
||||
Reference in New Issue
Block a user