Skip to content

Commit 8a38bfd

Browse files
committed
Update ReadMe with installation instructions
Signed-off-by: Sara Damiano <[email protected]>
1 parent 951b15e commit 8a38bfd

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Extensive documentation on the SDI-12 functions and classes is available here:
3333
- [Documentation](#documentation)
3434
- [Renaming Notice](#renaming-notice)
3535
- [Getting Started](#getting-started)
36+
- [Library installation](#library-installation)
3637
- [Origins and Inherited Limitations](#origins-and-inherited-limitations)
3738
- [Compatibility Considerations](#compatibility-considerations)
3839
- [Variants and Branches](#variants-and-branches)
@@ -57,6 +58,19 @@ Try running our [Example sketches](https://github.com/EnviroDIY/Arduino-SDI-12/t
5758

5859
Full details on the library functionality can be found on github pages: <https://envirodiy.github.io/Arduino-SDI-12/>
5960

61+
## Library installation
62+
63+
This library is available through both the Arduino and PlatformIO library registries.
64+
65+
Within the Arduino IDE, you can find the library in the library registry using the library search tool.
66+
The build and ingest logs for this library into the Arduino library registry are available [here](https://downloads.arduino.cc/libraries/logs/github.com/EnviroDIY/Arduino-SDI-12/).
67+
The Arduino library registry should show newly available versions of this library within a few hours of a new release.
68+
69+
[Here is the PlatformIO registry page.](https://registry.platformio.org/libraries/envirodiy/SDI-12)
70+
The library can be installed using the PlatformIO command `pio pkg install --library "envirodiy/SDI-12"`,
71+
You can also include this SDI-12 library as a dependency for a project by adding `envirodiy/SDI-12` to the [lib_deps](https://docs.platformio.org/en/latest/projectconf/sections/env/options/library/lib_deps.html) section of your platformio.ini configuration file.
72+
The PlatformIO library registry will should newly available versions of this library within minutes of a new release.
73+
6074
## Origins and Inherited Limitations<!--! {#mainpage_origins} -->
6175

6276
This library was developed from the [SoftwareSerial](https://github.com/arduino/Arduino/tree/master/hardware/arduino/avr/libraries/SoftwareSerial) library that is a built-in [standard Arduino library](https://www.arduino.cc/en/Reference/Libraries).

0 commit comments

Comments
 (0)