Skip to content

Commit 1a90012

Browse files
committed
readme updates
1 parent 599fb5d commit 1a90012

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

readme.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,14 @@ Homebridge is amazing, but don't you wish there was a way to view it in a pretti
1717
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!
1818

1919
## 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.
2122

2223
Alternatively, install it from npm using `sudo -E -n npm install homebridge-display@latest`
2324

2425
## 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.
2628

2729
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:
2830

@@ -31,6 +33,7 @@ When changing the widget settings, if there are additional config settings liste
3133
**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.**
3234

3335
## Usage
36+
3437
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.
3538

3639
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
4447
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.
4548

4649
### [Feature Request/Bug Fixes](https://github.com/EricAndrechek/homebridge-display/projects/1)
47-
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=)
4850

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=)
4952

5053
### Widgets
5154

5255
#### [Widgets in Development](https://github.com/EricAndrechek/homebridge-display/projects/2)
56+
5357
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=)
5458

5559
#### Current Widgets:
56-
* [Accessory Control](https://github.com/EricAndrechek/homebridge-display/wiki/Accessory-Control)
57-
* [Blank](https://github.com/EricAndrechek/homebridge-display/wiki/Blank)
58-
* [Calculator](https://github.com/EricAndrechek/homebridge-display/wiki/Calculator)
59-
* [Lyrics](https://github.com/EricAndrechek/homebridge-display/wiki/Lyrics)
60-
* [News](https://github.com/EricAndrechek/homebridge-display/wiki/News)
61-
* [Spotify](https://github.com/EricAndrechek/homebridge-display/wiki/Spotify)
62-
* [Weather](https://github.com/EricAndrechek/homebridge-display/wiki/Weather)
60+
61+
- [Accessory Control](https://github.com/EricAndrechek/homebridge-display/wiki/Accessory-Control)
62+
- [Blank](https://github.com/EricAndrechek/homebridge-display/wiki/Blank)
63+
- [Calculator](https://github.com/EricAndrechek/homebridge-display/wiki/Calculator)
64+
- [Clock](https://github.com/EricAndrechek/homebridge-display/wiki/Clock)
65+
- [Lyrics](https://github.com/EricAndrechek/homebridge-display/wiki/Lyrics)
66+
- [News](https://github.com/EricAndrechek/homebridge-display/wiki/News)
67+
- [Spotify](https://github.com/EricAndrechek/homebridge-display/wiki/Spotify)
68+
- [Sonos](https://github.com/EricAndrechek/homebridge-display/wiki/Sonos)
69+
- [Weather](https://github.com/EricAndrechek/homebridge-display/wiki/Weather)
6370

6471
#### Future Widgets:
72+
6573
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.
6674

6775
#### Widget Request:
76+
6877
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.
6978

7079
## Contributors
80+
7181
<a href="https://github.com/EricAndrechek/homebridge-display/graphs/contributors">
7282
<img src="https://contributors-img.web.app/image?repo=EricAndrechek/homebridge-display" />
7383
</a>
7484

7585
## Support
76-
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&currency_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&currency_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

Comments
 (0)