diff --git a/README.md b/README.md index 632b6de..9541dcf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# 1wire-search -Cleanly reimplemented 1-Wire bus search algorithm +# 1-Wire search algorithm + +This project provides a reimplemented 1-Wire bus search algorithm +(used to identify e.g. DS18x20 thermometers on a common open-drain bus). + +The algorithm uses no global variables and allows finding +a unlimited number of bus devices. + +For an example of usage, see `main.c`.