Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MatiasTK committed Jan 14, 2024
1 parent 76e9f85 commit 0bdec74
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# WiZ App 💡

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

## Preview 📌

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

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

> [!IMPORTANT]
> This app is still in development, so it may have some bugs.
## Installation 🔧

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:

- Clone the repo.
- Install the dependencies with `npm install`.
- Run `npm run make` to build the app.
- The app will be in the `out` folder.

## Built with 🛠️

- [ElectronJS](https://www.electronjs.org/) - Framework used.
- [Bootstrap](https://getbootstrap.com/) - Used for the UI.

## Responsibilities 📖

This app is not affiliated with WiZ in any way.

0 comments on commit 0bdec74

Please sign in to comment.