fix: updated readme to include usage instructions

This commit is contained in:
Britton Hayes 2021-10-01 00:36:12 -07:00
parent ea9a13c9a8
commit 6fc4d63bf2
No known key found for this signature in database
GPG key ID: 922B4F3652980643

View file

@ -1,3 +1,39 @@
# Validate YAML # Validate YAML
> Github action to validate yaml files against a JSON schema > Github action to validate yaml files against a JSON schema
## Usage
Validate your YAML files against a JSON structure by providing a schema path and a list of files.
```yaml
- name: Validate YAML
uses: brittonhayes/validate-yaml
with:
schemaPath: 'schema.json'
files: |
example/foo.yaml
```
### Example JSON Schema
```json
{
"test": {
"structure": {
"myValue": "string",
"myValue2": "string"
}
}
}
```
### Example Valid YAML for this schema
```yaml
---
test:
structure:
myValue: '1'
myValue2: '2'
```