diff --git a/catalogs/protocol-parser/README.md b/catalogs/protocol-parser/README.md index 3974dee630..9f57066f37 100644 --- a/catalogs/protocol-parser/README.md +++ b/catalogs/protocol-parser/README.md @@ -1,3 +1,10 @@ # @pnpm/catalogs.protocol-parser > Parse catalog protocol specifiers and return the catalog name. + +Catalog protocol specifiers start with `catalog:`. The parser reads the value after that prefix as the catalog name, and returns `default` when no name is provided. + +## Examples + +- `catalog:foo` -> `"foo"` +- `catalog:` -> `"default"`