search

256dpi / arduino-mqtt

MQTT library for Arduino
MIT License
1.01k stars 232 forks source link

Finding this in the Arduino IDE Library Manager #267

Closed sheffieldnikki closed 1 year ago

sheffieldnikki commented 2 years ago

The README.md says to search for "MQTT" to find this in the Arduino IDE's builtin Library Manager. However that will list dozens and dozens of projects that mention "mqtt" in their project name or description.

I'd suggest updating the README.md to instead search for "lwmqtt" to list only this library, or if you do search with "MQTT", note that the library is called just "MQTT" in the Library Manager and is by "Joel Gaehwiler", to distinguish it from all the similar libraries.

256dpi commented 1 year ago

I updated the Readme. Thanks for the suggestion!

sheffieldnikki commented 1 year ago

The updated text: Or even better use the builtin Library Manager in the Arduino IDE and search for "lwmqtt" or "MQTT".

is an improvement, but I would remove the or "MQTT" entirely. Searching for "lwmqtt" finds the correct library immediately with a single result, while searching "MQTT" gives 105 results, making it very tedious and error prone to find the correct library.

If you are editing it, might as well also fix the typo "builtin" to "built-in".