Skip to content

Commit

Permalink
Add more to README (#9)
Browse files Browse the repository at this point in the history
* Add more to README

* Add link to workflows

* Update link
  • Loading branch information
jesserockz committed Jun 2, 2022
1 parent 8eb20c1 commit cc3338d
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# ESPHome Build action

## inputs
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/esphome/build-action)

### `yaml_file`

**Required**. The YAML filename to be compiled.
This action takes a yaml file for an ESPHome device and will compile and output
the build firmware file and a partial `manifest.json` file that can be used to flash
a device via [ESP Web Tools](https://esphome.github.io/esp-web-tools).

## Example usage

Expand All @@ -15,3 +16,22 @@ with:
yaml_file: my_configuration.yaml

```

This action is used by the [ESPHome publish workflow](https://github.com/esphome/workflows/blob/main/.github/workflows/publish.yml) that is used to compile firmware and publish simple GitHub pages sites for projects.

## Inputs

Name | Default | Description
-----|---------|------------
`yaml_file` | _None_ | The YAML file to be compiled.
`version` | `latest` | The ESPHome version to build using.

## Outputs

Name | Description
-------|------------
`name` | The name of the device in yaml with the platform (eg. ESP32 or ESP8266) appended.

## Output files

This action will output a folder named with the output `name` and will contain two files, `{name}.bin` and `manifest.json`.

0 comments on commit cc3338d

Please sign in to comment.