Skip to content

Commit

Permalink
Update README.md with project description and features
Browse files Browse the repository at this point in the history
  • Loading branch information
jozefnad committed Feb 26, 2024
1 parent cee208c commit aa89e2c
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
# Vue 3 + Vite
This project is a progressive web application (PWA) for controlling Balboa SPA hot tubs. It works as a web, Android, and iOS app.

This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
## Features

Users can control:

- Target temperature
- Time
- Heat mode
- Ranges
- Pumps
- Blowers
- Auxs
- Lights
- Filter cycles
- etc.

## Requirements

- Users need to have a WiFi module with the old Balboa app (Spa Control) and have set up Cloud Connect.

## Built With

- Vue.js + Vite

## API

- Balboa Cloud API (bwgapi)

## Recommended IDE Setup

Expand Down

0 comments on commit aa89e2c

Please sign in to comment.