From 27c184eae6fd9c0d23f5842d4ed10155a2945350 Mon Sep 17 00:00:00 2001 From: Bill Thomson Date: Sat, 26 Nov 2022 12:05:56 -0600 Subject: [PATCH] Update readme.md Syntax edit --- usermods/readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/usermods/readme.md b/usermods/readme.md index 0c56efaed2..8aa8d6abcf 100644 --- a/usermods/readme.md +++ b/usermods/readme.md @@ -2,17 +2,17 @@ This folder serves as a repository for usermods (custom `usermod.cpp` files)! -If you have created an usermod that you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request! +If you have created a usermod you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request! In order for other people to be able to have fun with your usermod, please keep these points in mind: - Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`) - Include your custom files -- If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one has to take to use the usermod +- If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take - Create a pull request! - If your feature is useful for the majority of WLED users, I will consider adding it to the base code! -While I do my best to not break too much, keep in mind that as WLED is being updated, usermods might break. +While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break. I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod. For new usermods, I would recommend trying out the new v2 usermod API, which allows installing multiple usermods at once and new functions!