diff --git a/.codespellrc b/.codespellrc index 101edae..49c3fe0 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,7 +1,7 @@ # See: https://github.com/codespell-project/codespell#using-a-config-file [codespell] # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: -ignore-words-list = , +ignore-words-list = wan, check-filenames = check-hidden = skip = ./.git diff --git a/README.adoc b/README.adoc index 21601bb..e9370a6 100644 --- a/README.adoc +++ b/README.adoc @@ -7,7 +7,15 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] -This library allows the control and configuration of the BQ24195 PMIC used on various Arduino boards. +This library allows the control and configuration of the BQ24195 PMIC as part of the following Arduino boards: + +* The following MKR boards +** MKR WIFI 1010 (SKU: ABX00023) +** MKR WAN 1310 (SKU: ABX00029) +** MKR GSM 1400 (SKU: ABX00018) +** MKR NB 1500 (SKU: ABX00019) +* Nano Motor Carrier (SKU: ABX00041) +* Portenta Max Carrier (SKU: ABX00043) The library is in beta and its APIs are not stable yet.