From a2ee1b3d1f40776032473b18f095dc8c299db21f Mon Sep 17 00:00:00 2001 From: "theis.gaedigk" Date: Fri, 1 Aug 2025 19:48:39 +0200 Subject: [PATCH] chore: remove detailed usage instructions and features from README for web-only version --- README.md | 51 +-------------------------------------------------- 1 file changed, 1 insertion(+), 50 deletions(-) diff --git a/README.md b/README.md index f390e6d..d48a69f 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,6 @@ # Weather App -This is a simple weather application that allows users to view current weather data for a specified location. The app is built using React and TypeScript, and it fetches weather data from an external API. - -> For that we use the OpenWeatherMap API. You can get your own API key by signing up at [OpenWeatherMap](https://openweathermap.org/api). - -## Features - -- Search for weather by city name -- Display current weather conditions including temperature, humidity, and wind speed -- Responsive design for mobile and desktop views -- Change API key preferences -- Display weather data in a user-friendly format - -## Installation - -1. Clone the repository: - ```bash - git clone https://git.the1s.de/theis.gaedigk/weather-app.git - ``` -2. Navigate to the frontend project directory: - ```bash - cd weather-app/frontend - ``` -3. Install dependencies: - ```bash - npm install - ``` -4. Start the development server: - ```bash - npm run dev - ``` -5. Open your browser and go to `http://localhost:7002` to view the app. - **Note:** There is also a backend server directory, which is currently not in use. - You can ignore it for now. - -## Usage - -1. Get an API key from [OpenWeatherMap](https://openweathermap.org/api). -2. Click on the "Set API Key" button in the header to enter your API key. -3. Enter a city name in the search bar and press Enter or click the "Get Weather" button. - -**Now you can view the current weather data for the specified city!** - -# Other Information - -## Technologies Used - -- React -- TypeScript -- Tailwind CSS -- OpenWeatherMap API -- Vite +This version is only meant for publishing on the web. It is not meant for local development or use. ## Version