Skip to content

Commit

Permalink
Better README
Browse files Browse the repository at this point in the history
  • Loading branch information
jBugman authored Mar 8, 2023
1 parent 7f05a5e commit 61b013a
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Set GitHub status to weather at your location
# Update your GitHub status with the current weather at your location

Place an `.env` file in the working directory containing:

Create `.env` file with:
1. `WEATHERAPICOM_API_KEY` API key for [weatherapi.com](https://www.weatherapi.com). A free account is enough.
2. `GITHUB_TOKEN` [Personal access token (classic)](https://github.com/settings/tokens/new) with scope `user`. Please keep in mind that, in general, it's not safe to trust random software with tokens like that.
3. `LAT` and `LON` for a location. You can get it from Google Maps.
3. `LAT` and `LON` for the location. You can get it from Google Maps, i.e.

---

<a href="https://www.weatherapi.com/" title="Free Weather API"><img src='//cdn.weatherapi.com/v4/images/weatherapi_logo.png' alt="Weather data by WeatherAPI.com" border="0"></a>
Powered by <a href="https://www.weatherapi.com/" title="Free Weather API">WeatherAPI.com</a>

0 comments on commit 61b013a

Please sign in to comment.