You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+22-11Lines changed: 22 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,14 @@ Homebridge is amazing, but don't you wish there was a way to view it in a pretti
17
17
With Homebridge-Display, you can control and view Spotify, see the weather forecast and current conditions, see news articles, control some homebridge devices, and much, much more!
18
18
19
19
## Installation
20
-
Using the [Config UI X Plugin](https://github.com/oznu/homebridge-config-ui-x#readme) search for "homebridge display" and install it.
20
+
21
+
Using the [Config UI X Plugin](https://github.com/oznu/homebridge-config-ui-x#readme) search for "homebridge display" and install it.
21
22
22
23
Alternatively, install it from npm using `sudo -E -n npm install homebridge-display@latest`
23
24
24
25
## Setup
25
-
All of the default values in the config are set up so that it will run properly (displaying only blank widgets) when you first run the server.
26
+
27
+
All of the default values in the config are set up so that it will run properly (displaying only blank widgets) when you first run the server.
26
28
27
29
When changing the widget settings, if there are additional config settings listed below the widget selection they must be configured in order for the server to start and run properly. Here is an example of what these additional config values look like:
28
30
@@ -31,6 +33,7 @@ When changing the widget settings, if there are additional config settings liste
31
33
**When you are done making changes and have restarted homebridge, navigate to your homebridge's IP address with the port listed in the config after it. This defaults to `http://homebridge.local:6969` or `http://(your-homebridge-server-ip):6969` with "6969" being the custom port in config.**
32
34
33
35
## Usage
36
+
34
37
Currently, this works best on an iPad with a screen resolution of 1024px by 768px, but other resolutions will work. Please note that screen resolutions that are either excessively wide or tall will likely have trouble displaying things properly, but a fix is in progress.
35
38
36
39
For best results, **add this web app to your iOS device's homescreen so that it may display in fullscreen**.
@@ -44,33 +47,41 @@ For all features, bugs, and widgets, you can view their progress in their respec
44
47
You can also subscribe to a specific issue (feature request, bug report, or widget request) to be notified of when I begin working on it, how the progress is going, and when it is finished.
Start a [bug report](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=bug&template=bug_report.md&title=) or [feature request](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=&template=feature-request.md&title=)
48
50
51
+
Start a [bug report](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=bug&template=bug_report.md&title=) or [feature request](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=&template=feature-request.md&title=)
49
52
50
53
### Widgets
51
54
52
55
#### [Widgets in Development](https://github.com/EricAndrechek/homebridge-display/projects/2)
56
+
53
57
Pitch an idea for a new widget to be added [here](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=widget+request&template=widget-request.md&title=)
Click [here](https://github.com/EricAndrechek/homebridge-display/projects/2) to see my GitHub Projects Board for widgets I'm in the process of adding or have future plans to add.
66
74
67
75
#### Widget Request:
76
+
68
77
If your widget idea is not already listed as a future widget request, click [here](https://github.com/EricAndrechek/homebridge-display/issues/new?assignees=&labels=widget+request&template=widget-request.md&title=) to add a new one.
If you would like to support this project please feel free to create a pull request, create an issue to submit and idea or feature request, or **[donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=eric%40andrechek.com¤cy_code=USD&source=url)** or **[GitHub Sponsors](https://github.com/sponsors/EricAndrechek)**! (*Note, with GitHub Sponsors you have the ability to have your name added to the contributors list and even bring specific features or fixes to the top of my development queue. For more info, see the tier information on my GitHub sponsors page.)
86
+
87
+
If you would like to support this project please feel free to create a pull request, create an issue to submit and idea or feature request, or **[donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=eric%40andrechek.com¤cy_code=USD&source=url)** or **[GitHub Sponsors](https://github.com/sponsors/EricAndrechek)**! (\*Note, with GitHub Sponsors you have the ability to have your name added to the contributors list and even bring specific features or fixes to the top of my development queue. For more info, see the tier information on my GitHub sponsors page.)
0 commit comments