Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch clone command to fork #1

Merged
merged 1 commit into from
May 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,12 @@ using data from the OpenWeather One Call API. This is a replacement module for M

**NOTE** This module uses the Nunjucks templating system introduced in version 2.2.0 of MagicMirror. If you're seeing nothing on your display where you expect this module to appear, make sure your MagicMirror version is at least 2.2.0.


## Installation

1. Navigate into your MagicMirror `modules` folder and execute<br>
`git clone https://github.com/jclarke0000/MMM-OpenWeatherForecast.git`.
`git clone https://github.com/Tom-Hirschberger/MMM-OpenWeatherForecast`.
2. Enter the new `MMM-OpenWeatherForecast` directory and execute `npm install`.



## Configuration

At a minimum you need to supply the following required configuration parameters:
Expand All @@ -35,7 +32,7 @@ By default the module uses the now deprecated OpenWeatherMap One Call API in ver
Make sure to subscribe to the new 3.0 API first and wait a couble of hours till the subscription is activated. You will need to provide payment information for the new subscription but as long as you stay under the daily free limit (1000 calls at the moment) you will not be charged.

e.g.,
```
```js
{
module: "MMM-OpenWeatherForecast",
position: "top_right",
Expand Down Expand Up @@ -228,7 +225,7 @@ For each of current conditions, hourly forecast and daily forecast, there are ad
### Valid options for <code>extraCurrentConditions</code>

This shows all available options:
```
```js
extraCurrentConditions: {
highLowTemp: true,
precipitation: true,
Expand All @@ -244,7 +241,7 @@ This shows all available options:
```

This shows just Hi/Low temp display and precipitation:
```
```js
extraCurrentConditions: {
highLowTemp: true,
precipitation: true,
Expand All @@ -261,7 +258,7 @@ This shows just Hi/Low temp display and precipitation:

### Valid options for <code>hourlyExtras</code>

```
```js
hourlyExtras: {
precipitation: true,
wind: true,
Expand All @@ -275,7 +272,7 @@ This shows just Hi/Low temp display and precipitation:

### Valid options for <code>dailyExtras</code>

```
```js
dailyExtras: {
precipitation: true,
sunrise: true,
Expand All @@ -290,7 +287,7 @@ This shows just Hi/Low temp display and precipitation:

## Sample Configuration

```
```js
{
module: "MMM-OpenWeatherForecast",
position: "top_right",
Expand Down Expand Up @@ -374,7 +371,7 @@ This shows just Hi/Low temp display and precipitation:

This module is set to be 320px wide by default. If you wish to override it, you can add the following to your `custom.css` file:

```
```css
.MMM-OpenWeatherForecast .module-content {
width: 500px; /* adjust this as desired */
}
Expand Down