Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MatiasTK committed Jan 19, 2025
1 parent a884b2b commit 0892867
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 23 deletions.
68 changes: 45 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,45 @@
# WiZ App 💡

_Simple ElectronJS APP to connect and control [WiZ](https://www.wizconnected.com/es-ar) Bulbs._

## Preview 📌

![Preview](https://i.imgur.com/vs6W5wM.png)

![Scenes](https://i.imgur.com/8AsMpvc.png)

![Custom](https://i.imgur.com/AIDfSRU.png)

## Installation 🔧
<div align="center">
<h1>WiZ APP 💡</h1>
<br>
<i>Simple desktop app to connect and control <a href="https://www.wizconnected.com/">WiZ</a> Bulbs.</i>
<br>
<br>
<a href="https://github.com/MatiasTK/WizAPP/releases/latest">
<img src="https://img.shields.io/github/downloads/MatiasTK/WizAPP/total?style=for-the-badge" alt="Downloads">
</a>
<a href="https://github.com/MatiasTK/WizAPP/releases/latest">
<img src="https://img.shields.io/github/v/release/MatiasTK/WizAPP?style=for-the-badge" alt="Release">
</a>
<img src="https://img.shields.io/github/license/MatiasTK/WizAPP?style=for-the-badge" alt="License">
<br>
<br>
<p align="center">
<a href="#features-">Features</a> •
<a href="#download-">Download</a> •
<a href="#building-">Building</a> •
<a href="#troubleshooting-">Troubleshooting</a> •
<a href="#stack-%EF%B8%8F">Stack</a> •
<a href="#responsibilities-">Responsibilities</a>
</p>
</div>

![preview](https://github.com/MatiasTK/WizAPP/blob/main/img/preview.gif?raw=true)

## Features 🌟

- Discover your bulbs automatically.
- Turn on/off your bulbs.
- Change the scene of your bulbs.
- Change the brightness of your bulbs.
- Set custom bulb scene colors.
- Notification when an update is available.
- Spanish and English language support.
- Minimize to tray.

## Download 📥

You can download the latest release from [here](https://github.com/MatiasTK/WizAPP/releases/latest).

## Usage 🚀

- Open the app.
- Wait for the app to find your bulbs.
- Now you can turn on/off your bulbs and change their scene.

## Building 📦

If you want to build the app yourself, you can do it by following these steps:
Expand All @@ -33,11 +53,13 @@ If you want to build the app yourself, you can do it by following these steps:

If the app have trouble discovering your bulbs, you can enter the IP manually. You can find the IP of your bulbs in the WiZ Android app.

## Built with 🛠️
## Stack 🛠️

- [ElectronJS](https://www.electronjs.org/) - Desktop Framework used.
- [Bootstrap](https://getbootstrap.com/) - Used for the UI.
- [React](https://react.dev/) - Web framework used.
- [![ElectronJS](https://img.shields.io/badge/Electron-2B2E3A?style=for-the-badge&logo=electron&logoColor=9FEAF9)](https://www.electronjs.org/) - Desktop Framework used.
- [![ReactJS](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)](https://reactjs.org/) - Frontend Library used.
- [![Typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) - Language used.
- [![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)](https://getbootstrap.com/) - CSS Framework used.
- [![I18next](https://img.shields.io/badge/I18next-0D2B3E?style=for-the-badge&logo=i18next&logoColor=white)](https://www.i18next.com/) - Internationalization library used.

## Responsibilities 📖

Expand Down
Binary file added img/preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0892867

Please sign in to comment.