Skip to content

Commit

Permalink
✏️ Final update for plugin repository prep
Browse files Browse the repository at this point in the history
  • Loading branch information
cp2004 committed Apr 16, 2021
1 parent 0b307ce commit f9863c9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 28 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# OctoPrint WLED Integration

### This plugin is still under development, while it works it is incomplete.
### If you want to see what is coming soon, have a look at the [the TODO issue](https://github.com/cp2004/OctoPrint-WLED/issues/2)

[WLED](https://github.com/Aircoookie/WLED) is an awesome project, as is [OctoPrint](https://octoprint.org).
What could be better than an OctoPrint plugin for connecting the two?

Expand Down Expand Up @@ -54,11 +51,12 @@ This is because the frontend code is built as part of the release process. For d

Configuration can be performed in the OctoPrint UI, under Settings > WLED Integration.

Pictures coming soon 😉!

## Contributing

Contributions welcome :)
Contributions are welcome, full contributing guidelines are coming soon.

If you are feeling like contributing a new feature, feel free to open an issue so we can discuss!

To setup the node environment for frontend stuff:

Expand All @@ -67,12 +65,14 @@ To setup the node environment for frontend stuff:
* Watch CSS development mode: `npm run dev-css`
* Build both assets in release mode: `npm run release`

These files *should not* be checked in, they are built on release automatically by a Github action.
These files *should not* be checked in, they are built on release automatically by a GitHub action.

## Credits

This plugin wouldn't be possible without the great work of [@frenck](https://github.com/frenck)'s
This plugin wouldn't be possible without the great work from [@frenck](https://github.com/frenck) with the
[python-wled](https://github.com/frenck/python-wled) Python module that I was able to use. It has been slightly modified
to work better within an OctoPrint plugin, but it is a great module to work with. Thank you!

[View the python-wled license](https://github.com/cp2004/OctoPrint-WLED/blob/main/octoprint_wled/wled/LICENSE.md)
*[View the OctoPrint-WLED license](https://github.com/cp2004/OctoPrint-WLED/blob/main/LICENSE.md)*

*[View the python-wled license](https://github.com/cp2004/OctoPrint-WLED/blob/main/octoprint_wled/wled/LICENSE.md)*
33 changes: 13 additions & 20 deletions extras/wled.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,12 @@ description: WLED is an awesome project, as is OctoPrint. What could be better t
author: Charlie Powell
license: AGPLv3

# TODO
date: 2021-04-14
date: 2021-04-16

homepage: https://github.com/cp2004/OctoPrint-WLED
source: https://github.com/cp2004/OctoPrint-WLED
archive: https://github.com/cp2004/OctoPrint-WLED/releases/latest/download/release.zip

# Set this to true if your plugin uses the dependency_links setup parameter to include
# library versions not yet published on PyPi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
#follow_dependency_links: false

tags:
- wled
- led
Expand All @@ -26,19 +21,15 @@ tags:
- rgb led
- status

# TODO
screenshots:
- url: url of a screenshot, /assets/img/...
alt: alt-text of a screenshot
caption: caption of a screenshot
- url: url of another screenshot, /assets/img/...
alt: alt-text of another screenshot
caption: caption of another screenshot
- ...

# TODO
featuredimage: url of a featured image for your plugin, /assets/img/...
- url: /assets/img/plugins/wled/plugin.png
alt: WLED + OctoPrint
caption: WLED meets OctoPrint!
- url: /assets/img/plugins/wled/settings.png
alt: WLED Settings
caption: Sample of the WLED Settings

featuredimage: /assets/img/plugins/wled/plugin.png

compatibility:
octoprint:
Expand All @@ -62,12 +53,14 @@ aims to provide a similar experience of high configurability with ease of use.
- Print success
- Print failed
- Print paused
- Highly configurable settings
- Easy to use UI
- Tracking print progress
- Highly configurable settings & and easy to use UI
- ... and more!

**This project is under early development, please be patient as bugs are fixed and features are added!**

**For the most up to date information, be sure to [check out the GitHub Repository](https://github.com/cp2004/OctoPrint-WLED)**

## Setup

### Compatibility
Expand All @@ -89,7 +82,7 @@ or manually using this URL:

Configuration can be performed in the OctoPrint UI, under Settings > WLED Integration.

Pictures coming soon 😉!
More documentation and explanation is on the way!

## Credits

Expand Down

0 comments on commit f9863c9

Please sign in to comment.