Skip to content

Commit d6edd7f

Browse files
committed
Fixup README.md
1 parent 2d75dcf commit d6edd7f

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# Voxelite plugin.json Validator
22

3-
This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
3+
GitHub Action to validate [Voxelite](https://github.com/voxelite)'s `plugin.json` (main information about the plugin).
4+
5+
Checks:
6+
- Presence of all required fields
7+
- Valid characters (especially for plugin's codename)
8+
- Impersonation prevention
49

510
## Inputs
611

712
### `file`
813

9-
**Required** Path to your `plugin.json`. Default `"plugin.json"` (=root directory of your repository).
14+
**Required**
15+
16+
Path to your `plugin.json`.
17+
Default `"plugin.json"` (=in root directory of your repository).
1018

1119
### `official`
1220

@@ -16,7 +24,8 @@ Causes the validator to not check against official names.
1624
## Example usage
1725

1826
```yaml
19-
uses: voxelite/plugin-json-validator
27+
- name: plugin.json validation
28+
uses: voxelite/plugin-json-validator@v1
2029
```
2130
22-
For `plugin.json` format look into official documentation, some examples can be found in [test directory](test).
31+
For `plugin.json` format look into official documentation, some examples can be found in [test directory](test).

0 commit comments

Comments
 (0)