forecast/README.md
Mathis d3e1b122e4
docs: update README with new repo and install instructions
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.
2024-09-27 10:52:12 +02:00

35 lines
653 B
Markdown

# Weather App
Check the current weather on any city on the planet. Switch between metric and imperial units.
## Features
Currently being redesigned
## Installation
1. `git clone ssh://git@git.yidhra.fr:3022/Mathis/forecast.git`
2. `cd forecast`
3. `pnpm install` || `yarn install`
4. Log-in to [Openweathermap.com](https://openweathermap.org/)
5. Create an API key
6. `cp .env.example .env.local`
7. Paste API key for `OPENWEATHER_API_KEY`
8. `pnpm dev` || `yarn run dev`
## Contributions
You're free to go! For more information, see the license.
## License
The project is under [MIT license](https://choosealicense.com/licenses/mit/).