Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
balloob authored Apr 13, 2022
1 parent e6bf67b commit d87f076
Showing 1 changed file with 2 additions and 30 deletions.
32 changes: 2 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ESP Web Tools

Allow flashing ESPHome or other ESP-based firmwares via the browser. Will automatically detect the board type and select a supported firmware.
Allow flashing ESPHome or other ESP-based firmwares via the browser. Will automatically detect the board type and select a supported firmware. [See website for full documentation.](https://esphome.github.io/esp-web-tools/)

```html
<esp-web-install-button
manifest="firmware_esphome/manifest.json"
></esp-web-install-button>
```

Manifest definition:
Example manifest:

```json
{
Expand Down Expand Up @@ -63,34 +63,6 @@ Manifest definition:
}
```

## Styling

### Attributes

The following attributes are automatically added to `<esp-web-install-button>` and can be used for styling:

| Attribute | Description |
| -- | -- |
| `install-supported` | Added if installing firmware is supported
| `install-unsupported` | Added if installing firmware is not supported

### CSS custom properties (variables)

The following variables can be used to change the colors of the default UI elements:

- `--esp-tools-button-color`
- `--esp-tools-button-text-color`

### Slots

The following slots are available:

| Slot name | Description |
| -- | -- |
| `activate` | Button to start the flash progress
| `unsupported` | Message to show when the browser is not supported
| `not-allowed` | Message to show when not a secure context

## Development

Run `script/develop`. This starts a server. Open it on http://localhost:5001.

0 comments on commit d87f076

Please sign in to comment.