diff --git a/README.md b/README.md index d44bc98..059a3ad 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,93 @@ -# Biofects -Biofects theme is: A modern HUD display for Home Assistant. **[WIP]** +# πŸš€ Biofects Theme +**Biofects Theme** is a modern, futuristic HUD display for Home Assistant, designed to be both visually striking and easy to use. **[WIP]** -Biofects Theme Main -Biofects Theme Sample Page +

+ Biofects Theme Main + Biofects Theme Sample Page +

+--- -# About this theme and why I made it -I made this theme to give a easy on the eyes look and simple to use for my family. This theme for my layout is also using many additional plugins to give me a look and feel that we found to be easy to navigate +## πŸ” About this Theme +I created the **Biofects Theme** to give my family a clean, easy-on-the-eyes interface with a simple layout that everyone can navigate. It's not just visually appealing but also designed to seamlessly integrate with additional plugins for a rich user experience. -1. My Home assistnat runs on a server in Docker. No I do not used supervised, no I do not send data to Home Assistant. This is my choice to struggle a bit more than a managed OS but I am ok with that. +- My Home Assistant runs in Docker on a server. I don't use the supervised version, nor do I send any data to Home Assistant servers. This is my personal choice, despite it requiring more manual management. + + I don’t know how it works with HAOS. -I dont know how it works with HAOS +- I prioritize securing my network by blocking **phone home** calls from IoT devices, ensuring data privacy. +- My Home Assistant setup includes an array of devices, with plans to expand further. Here’s a snapshot of what I manage: -2. I also try to secure any **phone home** calls from IOT devices on my network. -3. I have many IOT devices I have are need to add to my Home Assistant - - Hue - - Tuya - - Different Appliances - - Grafana to monitor everything - - Emby - - Fans - - Local AI running on server - - Pi Hole to block ads - - All my network gear, server, GPU, Filers monitoring, security - - Door Locks - - Cameras -This is just examples of what is in my Home Assistant. With plans to add more. + - πŸ’‘ Hue + - 🏠 Tuya + - πŸ“Š Grafana for monitoring + - 🎞️ Emby for media + - πŸšͺ Door locks + - πŸ”’ Cameras + - πŸ’» Local AI (on server) + - 🚦 Pi Hole for ad-blocking + - πŸ–₯️ Full network & server monitoring, including GPU & storage + - πŸŒ€ Fans + - And much more to come! +--- -### Donatiosn Welcome and Apprciated +## πŸ’Έ Donations Welcome! +If you find this theme useful, please consider donating. Your support is greatly appreciated! [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=TWRQVYJWC77E6) +--- -## Plugins I use to give me the get the layout I wanted ## -- [Sidebar Card](https://github.com/DBuit/sidebar-card) Create an easy to use navigation -- [Wall Panel](https://github.com/j-a-n/lovelace-wallpanel) Great screen saver -- [Card Mod](https://github.com/thomasloven/lovelace-card-mod) adding style to cards -- [Restriction Card](https://github.com/iantrich/restriction-card) Locking out the thermostats :) +## πŸ”§ Plugins I Use to Achieve My Layout +These are the essential plugins that helped me craft the Biofects Theme experience: + +- [Sidebar Card](https://github.com/DBuit/sidebar-card) – For an easy-to-navigate sidebar. +- [Wall Panel](https://github.com/j-a-n/lovelace-wallpanel) – A powerful screen saver. +- [Card Mod](https://github.com/thomasloven/lovelace-card-mod) – Add custom styling to cards. +- [Restriction Card](https://github.com/iantrich/restriction-card) – Lock access to things like thermostats. πŸ”’ - [Unifi Gateway](https://github.com/custom-components/sensor.unifigateway) - [Unifi Counter Sensors](https://github.com/clyra/unifics) -- [Simple Sticky Note](https://github.com/biofects/simple_sticky_note) +- [Simple Sticky Note](https://github.com/biofects/simple_sticky_note) – For quick notes. - [Clock Weather Card](https://github.com/pkissling/clock-weather-card) -## Installing the theme ## -### HACS (Recommended) - -#### Adding as a Custom Repository - -1. Make sure you have [HACS](https://hacs.xyz/) installed in your Home Assistant instance. -2. Go to the HACS panel, then click on the three dots in the top right corner and select "Custom repositories." -3. In the dialog that appears, paste the following URL: [https://github.com/biofects/biofects-theme](https://github.com/biofects/Biofects-theme) and select "Theme" as the category. -4. Click "Add," then navigate to the "Theme" tab, click the "+ Explore & Download Repositories" button, and search for "Biofects" -5. Install the theme and restart Home Assistant. -6. Go to User profile and change the theme to Biofects - +--- +## πŸš€ Installation Instructions +### HACS (Recommended) -Support -For bugs or feature requests, please open an issue on the GitHub repository. - -License -This project is licensed under the MIT License. +#### Step-by-Step Guide +1. Ensure [HACS](https://hacs.xyz/) is installed in your Home Assistant. +2. Open the HACS panel, click the three dots in the top-right corner, and select **"Custom Repositories."** +3. Add the following URL as a **Custom Repository**: + [https://github.com/biofects/biofects-theme](https://github.com/biofects/Biofects-theme) + and select **"Theme"** as the category. +4. Click **"Add,"** then navigate to the **"Theme"** tab, click **"+ Explore & Download Repositories"** and search for "Biofects." +5. Install the theme and restart Home Assistant. +6. Go to **User Profile** in Home Assistant and select the Biofects theme. -## How I made my layout using my theme and additional plugins +--- -### Please see my plugin list above +## πŸ› οΈ How I Created My Layout -1. I updated each dashboard to support Wall Panel and Sidebar-card -2. All the content of the YAML should be placed above the views in the dashboard. (I know I could make a template -- Maybe Later -[lovelace-dashboard.yaml](./examples/lovelace-dassboard.yaml) +To get the layout I wanted with Biofects Theme, I combined various plugins and customization: -3. I create an Sample box example -[Clock-Weather_card-configuration.yaml](./examples/Clock-Weather_card-configuration.yaml) +1. Updated each dashboard to support **Wall Panel** and **Sidebar Card**. +2. YAML for content and views should be placed above the dashboard views. +3. Example box for clock-weather card configuration: + [Clock-Weather_card-configuration.yaml](./examples/Clock-Weather_card-configuration.yaml) +4. Full Lovelace dashboard configuration: + [lovelace-dashboard.yaml](./examples/lovelace-dashboard.yaml) +--- +## πŸ› Support & Issues +If you encounter bugs or have feature requests, feel free to [open an issue](https://github.com/biofects/biofects-theme/issues) on the GitHub repository. +--- +## πŸ“œ License +This project is licensed under the MIT License.