docs(readme): add description of entrypoint

TomokiMiyauci · Jun 14, 2023 · 3dd4590 · 3dd4590
1 parent 2dc2ad1
commit 3dd4590
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,19 @@ Composite keys, TC39
 [proposal-richer-keys, compositeKey](https://github.com/tc39/proposal-richer-keys/tree/master/compositeKey)
 implementation.
 
+## Entrypoint
+
+This project provides ponyfill and polyfill.
+
+Polyfill has a side effect, so the endpoint is isolated.
+
+The entrypoint of each are as follows:
+
+| Type     | Entrypoint    |
+| -------- | ------------- |
+| Ponyfill | `mod.ts`      |
+| Polyfill | `polyfill.ts` |
+
 ## compositeKey
 
 `compositeKey` requires at least one component must be object that can be placed