Skip to content

Commit

Permalink
📝 Updates widget contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Lissy93 authored Feb 17, 2022
1 parent bb4658e commit 2e63da0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/widgets.md
Original file line number Diff line number Diff line change
Expand Up @@ -1791,15 +1791,15 @@ Alternatively, for displaying simple data, you could also just use the either th

Suggestions for widget ideas are welcome. But there is no guarantee that I will build your widget idea.

You can suggest a widget [here](https://git.io/Jygo3), please star the repo before submitting a ticket.

Please only request widgets for services that:
- Have a publicly accessible API
- Are CORS and HTTPS enabled
- Are free to use, or have a free plan
- Allow for use in their Terms of Service
- Would be useful for other users

You can suggest a widget [here](https://git.io/Jygo3), please star the repo before submitting a ticket. If you are a monthly GitHub sponsor, I will happily build out a custom widget for any service that meets the above criteria, usually 2 within weeks of initial request.

For services that are not officially supported, it is likely still possible to display data using either the [iframe](#iframe-widget), [embed](#html-embedded-widget) or [API response](#api-response) widgets. For more advanced features, like charts and action buttons, you could also build your own widget, using [this tutorial](/docs/development-guides.md#building-a-widget), it's fairly straight forward, and you can use an [existing widget](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets) (or [this example](https://git.io/JygKI)) as a template.

---
Expand Down

0 comments on commit 2e63da0

Please sign in to comment.