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.
This commit is contained in:
parent
2737427b6f
commit
d3e1b122e4
25
README.md
25
README.md
@ -2,31 +2,18 @@
|
|||||||
|
|
||||||
Check the current weather on any city on the planet. Switch between metric and imperial units.
|
Check the current weather on any city on the planet. Switch between metric and imperial units.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
1. User's ability to search cities
|
Currently being redesigned
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
## Installation
|
## 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/)
|
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`
|
7. Paste API key for `OPENWEATHER_API_KEY`
|
||||||
|
|
||||||
8. `npm run dev`
|
8. `pnpm dev` || `yarn run dev`
|
||||||
|
|
||||||
## Contributions
|
## Contributions
|
||||||
|
|
||||||
Any feature requests and pull requests are welcome!
|
You're free to go! For more information, see the license.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user