Mathis/forecast
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README with new repo and install instructions

Browse Source 
Changed the repository URL and adjusted installation instructions to use pnpm or yarn instead of npm. Removed outdated feature list and image, updated contributions section to include license information.
This commit is contained in:
Mathis H (Avnyr) 2024-09-27 10:52:12 +02:00
parent 2737427b6f
commit d3e1b122e4
Signed by: Mathis
GPG Key ID: DD9E0666A747D126
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -2,31 +2,18 @@
Check the current weather on any city on the planet. Switch between metric and imperial units.
![Alt img](https://images.ctfassets.net/zlsyc9paq6sa/3uBrJ07WSM40FpolgjInHY/7d886cb4187b52194bf9b63c183a1d3a/1627637330_x.gif)
## Features
1. User's ability to search cities
2. Current local time and date
3. Temperatures and humidity
4. Wind speed and direction
5. Sunrise and sunset times
6. Metric vs Imperial system
7. Error handling and loading info
Currently being redesigned
## Installation
1. `git clone https://github.com/madzadev/weather-app.git`
1. `git clone ssh://git@git.yidhra.fr:3022/Mathis/forecast.git`
2. `cd weather-app`
2. `cd forecast`
3. `npm install`
3. `pnpm install` || `yarn install`
4. Log-in to [Openweathermap.com](https://openweathermap.org/)
@ -36,11 +23,11 @@ Check the current weather on any city on the planet. Switch between metric and i
7. Paste API key for `OPENWEATHER_API_KEY`
8. `npm run dev`
8. `pnpm dev` || `yarn run dev`
## Contributions
Any feature requests and pull requests are welcome!
You're free to go! For more information, see the license.
## License