Skip to content

Commit 9f4becd

Browse files
Update README.md
1 parent 487667f commit 9f4becd

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

types/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
###PURL Type Definitions
1+
### PURL Type Definitions
22

33
This directory contains the machine-readable definitions of all registered Package-URL (PURL) types,
44
one JSON file for each type. These JSON files serve as the reference for PURL type specifications.
55

6-
##Contents
6+
## Contents
77

88
- **index.json**: The index of all registered PURL types as a simple list of types.
99
- Definitions: **<purl-type>-definition.json**: The definition for a specific PURL type (e.g.,
1010
maven-definition.json, npm-definition.json).
1111
- Tests: **<purl-type>-test.json**: The test suite for a specific PURL type.
1212

13-
##Definitions
13+
## Definitions
1414

1515
Each JSON file named *-definition.json in this directory follows the standard PURL Type Definition
1616
Schema, ensuring:
@@ -19,7 +19,7 @@ Schema, ensuring:
1919
- Machine-readability for validation and automation.
2020
- Standardized structure defining namespace, name, version, qualifiers, subpath, and repository behavior.
2121

22-
##Tests
22+
## Tests
2323

2424
Each JSON file named *-test.json in this directory follows the standard PURL Test Schema, ensuring:
2525

@@ -29,13 +29,12 @@ Each JSON file named *-test.json in this directory follows the standard PURL Tes
2929
advanced processing including flexible, recovering parsing of invalid PURL.
3030

3131

32-
33-
##Usage
32+
## Usage
3433

3534
- These JSON files are the the authoritative source for defining, validating and tesing PURL types.
3635
- They should be referenced by tools, libraries, and documentation generators.
3736

38-
##Contributions
37+
## Contributions
3938

4039
- Modifications must be made to these JSON files directly.
4140
- The type definitions, tests and index and validated for consistency on commit.

0 commit comments

Comments
 (0)