Skip to content

Commit 6868fc5

Browse files
committed
fix readme links
1 parent 7e15f6b commit 6868fc5

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ Introduction
1818
:target: https://github.com/psf/black
1919
:alt: Code Style: Black
2020

21-
**This code is for testing purposes only! If you are looking for a Bosch BME280 driver, please use the [Adafruit_CircuitPython_BME280 library](https://github.com/adafruit/Adafruit_CircuitPython_BME280)**.
21+
**This code is for testing purposes only! If you are looking for a Bosch BME280 driver, please use the `Adafruit_CircuitPython_BME280 <https://github.com/adafruit/Adafruit_CircuitPython_BME280>`_**.
2222

23-
This driver mocks the functionality of the [Adafruit_CircuitPython_BME280 library](https://github.com/adafruit/Adafruit_CircuitPython_BME280/), allowing you to test your code without
23+
This driver mocks the functionality of the `Adafruit_CircuitPython_BME280 <https://github.com/adafruit/Adafruit_CircuitPython_BME280>`_, allowing you to test your code without
2424
attaching physical hardware.
2525

26-
Instead of using random data, weather data is instead pulled from [the free OpenWeatherMaps API](https://openweathermap.org)
27-
and returned as if it were coming from the BME280 sensor properties. A free OpenWeatherMaps API key is **required** to use this library (see the Usage section below for more information).
26+
Instead of using random data, weather data is instead pulled from `the OpenWeatherMaps API <https://openweathermap.org/>`_
27+
and returned as if it were coming from the BME280 sensor properties. A free OpenWeatherMap API key is **required** to use this library (see the Usage section below for more information).
2828

2929
Dependencies
3030
=============
@@ -68,17 +68,19 @@ To install in a virtual environment in your current project:
6868
Usage Example
6969
=============
7070

71-
To obtain an OpenWeatherMaps API key, sign up for a free account at [OpenWeatherMaps](https://openweathermap.org) and [generate an API key](https://home.openweathermap.org/api_keys). Then, in the root of this
71+
To obtain an OpenWeatherMaps API key, sign up for a free account at `OpenWeatherMaps <https://openweathermap.org/>`_ and generate an API key. Then, in the root of this
7272
project, add a file called `settings.toml` with the following information:
7373

74-
.. code-block:: toml
74+
.. code-block:: shell
75+
7576
openweather_token = "my_api_key"
7677
openweather_location = "New York, US"
7778
openweather_units = "metric"
7879

79-
Where `openweather_token` is your OpenWeatherMaps API key, `openweather_location` is the location you want to pull weather data from, and `openweather_units` is the units you want the temperature to be returned in (either `metric` or `imperial`).
8080

81-
Then, run the code within examples/fake_bme280.py to use the "fake" BME280 sensor.
81+
Where openweather_token is your OpenWeatherMaps API key, openweather_location is the location you want to pull weather data from, and openweather_units is the units you want the temperature to be returned in (either "metric" or "imperial").
82+
83+
Then, run the code within "examples/fake_bme280.py" to use the "fake" BME280 sensor.
8284

8385
Documentation
8486
=============

0 commit comments

Comments
 (0)