Skip to content

Commit afdfb1f

Browse files
committed
use header, not note tag
1 parent 577cf09 commit afdfb1f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ The XM125 boasts an impressive range of up to 20 meters, allowing you to create
1919

2020
Looking for the board that matches this library - pick up a [SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (Qwiic)](https://www.sparkfun.com/sparkfun-pulsed-coherent-radar-sensor-acconeer-xm125-qwiic.html) at www.sparkfun.com.
2121

22-
> [!NOTE]
23-
> Version 2.0+ of this library is not compatible with Version 1.0 implementations/use. For Version 2.0, the single class defined by the library, `SparkFunXM125`, was divided into two distinct classes:
24-
>
25-
> * SparkFunXM125Distance - Used when the XM125 is running the ***Distance*** application
26-
> * SparkFunXM125Presence - Used when the XM125 is running the ***Presence*** application
27-
>
28-
> Moving to use Version 2.0 of the library just requires changing the class name used in your sketch - from `SparkFunXM125` to either `SparkFunXM125Distance` or `SparkFunXM125Presence`
22+
### Upgrading to Version 2.0
23+
24+
Version 2.0+ of this library is not compatible with Version 1.* implementations/use. For Version 2.0, the single class defined by the library, `SparkFunXM125`, was divided into two distinct classes:
25+
26+
* SparkFunXM125Distance - Used when the XM125 is running the ***Distance*** application
27+
* SparkFunXM125Presence - Used when the XM125 is running the ***Presence*** application
28+
29+
Moving to use Version 2.0 of the library just requires changing the class name used in your sketch - from `SparkFunXM125` to either `SparkFunXM125Distance` or `SparkFunXM125Presence`
2930

3031
## Functionality
3132

0 commit comments

Comments
 (0)