Skip to content

Commit

Permalink
docs: prettify README
Browse files Browse the repository at this point in the history
  • Loading branch information
alexlnkp authored Sep 4, 2024
1 parent 61d38fc commit 62fa10a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
[![C/C++ CI](https://github.com/alexlnkp/weatherscript/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/alexlnkp/weatherscript/actions/workflows/c-cpp.yml)
# WeatherScript - utility made for easy and fast yield of weather report for the area
# WeatherScript
Utility made for easy and fast yield of weather report for the area.

It uses a fantastic website called [**wttr.in**](https://wttr.in) for the weather report itself

A [**JSON library**](https://github.com/nlohmann/json) is made by [@nlohmann](https://github.com/nlohmann)!

The program is based off a python script by [@SolDoesTech](https://github.com/SolDoesTech), [SolDoesTech/HyprV/waybar/scripts/waybar-wttr.py](https://github.com/SolDoesTech/HyprV4/blob/c81cf650443d680bf7a589de6128d01020dd1bc6/HyprV/waybar/scripts/waybar-wttr.py)


### Why
This small program is made for people who want to check the weather, above all things. This might include checking the weather by displaying it in the Waybar or anything like that, too!


### Note
Website looks at your IP for the area you're located at. Using proxy or VPN will most likely yield incorrect results unless you specify location as an argument. For instruction look at the [**Usage**](https://github.com/alexlnkp/weatherscript/tree/master#usage) section.

Expand Down

0 comments on commit 62fa10a

Please sign in to comment.