Skip to content

Commit

Permalink
Merge pull request #47 from wthomson/patch-63
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
srg74 authored Dec 10, 2022
2 parents 7183b26 + 27c184e commit cb02c89
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions usermods/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down

0 comments on commit cb02c89

Please sign in to comment.