Skip to content

Commit

Permalink
chore(docs): improve the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ReidyT committed Oct 28, 2024
1 parent 5431cea commit 6d328ae
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,34 @@ To download a CSV file of temperatures, follow these steps:
- The first column should represent time in GMT+0, formatted in ISO 8601.
- The second column should contain the temperature values in °C.

```
time,temperature
1999-01-01T00:00,3.9
1999-01-01T01:00,3.7
```

Or

```
time,temperature
1999-01-01,4.5
1999-01-02,3.6
```

2. **File Location**:

- Ensure that your CSV file is placed in the `public` directory of your project.
- For example, if your file is named `temperatures.csv`, the path will be `'temperatures.csv'` when referencing it from the public directory (i.e., `public/temperatures.csv`).

3. **Data Source**:

- You can download the required CSV data from [Open Meteo](https://open-meteo.com/). Be aware of the measurement frequency, which can be either per hour or per day, based on historical data (per hour) or futur predictions (one temperature per day).
- You can download the required CSV data from [Open Meteo](https://open-meteo.com/).

> [!WARNING]
> The measurement frequency changes depending on whether you are queriying historical data (one temperature per hour) or futur predictions (one temperature per day).
4. **Using the TemperatureContext**:
- In TemperatureContext, you can load this CSV file by referencing the appropriate path. Make sure to handle the data correctly based on the specified format and structure. Also be sure to specify the measurement frequency, which can be either per hour or per day, based on your needs.
4. **Using the `TemperatureContext`**:
- In `TemperatureContext`, you can load this CSV file by referencing the appropriate path. Make sure to handle the data correctly based on the specified format and structure. Also be sure to specify the measurement frequency, which can be either per hour or per day, based on your needs.

Following these guidelines will ensure that your CSV file is correctly set up and accessible for the application.

Expand Down

0 comments on commit 6d328ae

Please sign in to comment.