Skip to content

Commit e56fd1d

Browse files
authored
Update README.md
1 parent 4d5fbf9 commit e56fd1d

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# TSValidatorCLI
2+
23
A small commandline tool to validate thunderstore packages locally before upload
4+
5+
## Usage
6+
7+
Use `--help` to see all command line switches. Default use is `-f <foldername>` to validate all files contained in the package.
8+
9+
## Current Validations
10+
11+
- Manifest.json is present
12+
- And valid JSON
13+
- And Contains all required keys
14+
- [Warn] And does not contain the `installers` key (unused)
15+
16+
- Icon.png is present
17+
- And contains a valid IHDR header
18+
- And has the correct width&height
19+
20+
- [Warn] License is present
21+
- [Warn] Changelog.md is present

0 commit comments

Comments
 (0)