Skip to content

Commit 97951eb

Browse files
committedJun 18, 2024
Update README.md to point to Official website
1 parent 9824f65 commit 97951eb

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed
 

‎README.md

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

3-
GitHub Action to validate [Voxelite](https://github.com/voxelite)'s `plugin.json` (main information about the plugin).
3+
GitHub Action to validate [Voxelite](https://voxelite.net)'s `plugin.json` (main information about the plugin).
44

55
Checks:
66
- Presence of all required fields
77
- Valid characters (especially for plugin's codename)
8-
- Impersonation prevention
8+
- Voxelite impersonation prevention
99

1010
## Inputs
1111

@@ -14,18 +14,28 @@ Checks:
1414
**Required**
1515

1616
Path to your `plugin.json`.
17-
Default `"plugin.json"` (=in root directory of your repository).
17+
Default `"plugin.json"` in current directory.
1818

1919
### `official`
2020

2121
Set to `true` for official Voxelite plugins.
2222
Causes the validator to not check against official names.
2323

24+
Do not use this unless you are an official plugin.
25+
It does not give you any advantage, just ignores checks for official-sounding names.
26+
2427
## Example usage
2528

2629
```yaml
2730
- name: plugin.json validation
2831
uses: voxelite/plugin-json-validator@v1
2932
```
3033
34+
```yaml
35+
- name: plugin.json validation
36+
uses: voxelite/plugin-json-validator@v1
37+
with:
38+
file: path/to/plugin.json
39+
```
40+
3141
For `plugin.json` format look into official documentation, some examples can be found in [test directory](test).

0 commit comments

Comments
 (0)