Skip to content

Commit 879ed68

Browse files
committed
(docs) Visual updates to README
1 parent 1e4b893 commit 879ed68

File tree

3 files changed

+15
-12
lines changed

3 files changed

+15
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
# react-weather [![build](https://github.com/denniskigen/react-weather/actions/workflows/ci.yml/badge.svg)](https://github.com/denniskigen/react-weather/actions/workflows/validate.yml) ![Deployment status](https://img.shields.io/github/deployments/denniskigen/react-weather/production?label=vercel&logo=vercel&logoColor=white) [![Coverage Status](https://coveralls.io/repos/github/denniskigen/react-weather/badge.svg?branch=main)](https://coveralls.io/github/denniskigen/react-weather?branch=main)
1+
<div align="center">
2+
<img height="72" width="72" src="./public/logo.svg" alt="App logo" />
3+
</div>
24

3-
> If you like React Weather, you'll :heart: [React Weather Next](https://react-weather-next.denniskigen.com)!
5+
![Landing page screenshot](./public/screenshot.png)
46

5-
React Weather is a beautiful weather app that uses the [OpenWeatherMap API](https://openmweathermap.org/api).
7+
[![build](https://github.com/denniskigen/react-weather/actions/workflows/ci.yml/badge.svg)](https://github.com/denniskigen/react-weather/actions/workflows/validate.yml) ![Deployment status](https://img.shields.io/github/deployments/denniskigen/react-weather/production?label=vercel&logo=vercel&logoColor=white) [![Coverage Status](https://coveralls.io/repos/github/denniskigen/react-weather/badge.svg?branch=main)](https://coveralls.io/github/denniskigen/react-weather?branch=main)
68

7-
[See it live](https://react-weather.denniskigen.com)
8-
9-
![Home page](https://github.com/denniskigen/react-weather/blob/main/public/screen.png)
9+
[React Weather](https://react-weather.denniskigen.com) is a beautiful weather app built on top of the [OpenWeatherMap API](https://openmweathermap.org/api).
1010

1111
## Getting started
1212

1313
- Sign up over at [openweathermap.org](https://openweathermap.org/appid) and get an API key.
1414
- Fork the project and clone it locally.
15-
- Create a file at the root of the project called `.env.local` with the following contents:
15+
- Install dependencies using [pnpm](https://pnpm.io/installation):
1616

1717
```sh
18+
pnpm install
19+
```
20+
21+
- Create a file at the root of the project called `.env.local` with the following contents:
22+
23+
```
1824
VITE_API_URL = 'https://api.openweathermap.org/data/2.5'
1925
VITE_API_KEY = The API key you obtained from openweathermap.org
2026
VITE_ICON_URL = 'https://openweathermap.org/img/w'
2127
```
2228

23-
- Install dependencies using [pnpm](https://pnpm.io/installation):
24-
25-
```sh
26-
pnpm install
27-
```
29+
g

public/logo.svg

Lines changed: 1 addition & 0 deletions
Loading

public/screenshot.png

-80.6 KB
Loading

0 commit comments

Comments
 (0)