Update README.md

Added more details regarding properly defining the slug
This commit is contained in:
Daniel W. Anner 2023-04-13 11:06:17 -04:00 committed by GitHub
parent ad7230b114
commit 7f88be73ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -23,7 +23,7 @@ Each definition **must** include at minimum the following fields:
- `model`: The model number of the device type. This must be unique per manufacturer.
- Type: String
- `slug`: A URL-friendly representation of the model number. Like the model number, this must be unique per
manufacturer.
manufacturer. All slugs should have the manufacturers name appended to it with a dash, please see the example below.
- Type: String
- Pattern: `"^[-a-zA-Z0-9_]+$"`. Must match the following characters: `-`, `_`, Uppercase or Lowercase `a` to `z`, Numbers `0` to `9`.