Add customElements package.json field to README (#50)

webcomponents · May 3, 2021 · e527701 · e527701
1 parent c03b0f6
commit e527701
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,17 @@ Import the TypeScript types:
 import * as schema from 'custom-elements-manifest/schema';
 ```
 
+## Referencing manifests from npm packages
+
+In order to allow tools to find npm packages with custom element manifests without having to download package tarballs, packages should have a `"customElements"` field in their `package.json` that points to the manifest:
+
+```json
+{
+  "name": "example-package",
+  "customElements": "custom-elements.json",
+}
+```
+
 ## Schema Versioning
 
 The schema has a `schemaVersion` field in the top-level object to facilitate