Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobynLlama authored Aug 3, 2024
1 parent 4d5fbf9 commit e56fd1d
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# TSValidatorCLI

A small commandline tool to validate thunderstore packages locally before upload

## Usage

Use `--help` to see all command line switches. Default use is `-f <foldername>` to validate all files contained in the package.

## Current Validations

- Manifest.json is present
- And valid JSON
- And Contains all required keys
- [Warn] And does not contain the `installers` key (unused)

- Icon.png is present
- And contains a valid IHDR header
- And has the correct width&height

- [Warn] License is present
- [Warn] Changelog.md is present

0 comments on commit e56fd1d

Please sign in to comment.