From d3e1b122e43821001578c40363fa301c9835976a Mon Sep 17 00:00:00 2001 From: Mathis Date: Fri, 27 Sep 2024 10:52:12 +0200 Subject: [PATCH] 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. --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 7ab170e..c844632 100644 --- a/README.md +++ b/README.md @@ -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