From b8be0fe8ec33daf5bce989190fd612836ddd1fc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jozef=20Steinh=C3=BCbl?= Date: Tue, 8 Jul 2025 22:48:13 +0200 Subject: [PATCH] docs: show table --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7e66648..ee285f9 100644 --- a/README.md +++ b/README.md @@ -41,11 +41,13 @@ You can configure multiple package registries using the `registries` input. This #### Registry format options -- **Default registry**: `https://registry.npmjs.org/` -- **Default registry with token**: `https://registry.npmjs.org/|$TOKEN` -- **Scoped registry**: `@scope:https://registry.example.com/` -- **Scoped registry with token**: `@scope:https://registry.example.com/|$TOKEN` -- **Scoped registry with URL credentials**: `@scope:https://username:$PASSWORD@registry.example.com/` +| Type | Format | Example | +| ------------------------------------ | --------------------------------------------------------- | ----------------------------------------------------- | +| Default registry | `https://registry.example.com/` | `https://registry.npmjs.org/` | +| Default registry with token | `https://registry.example.com/\|$TOKEN` | `https://registry.npmjs.org/\|$NPM_TOKEN` | +| Scoped registry | `@scope:https://registry.example.com/` | `@myorg:https://npm.pkg.github.com/` | +| Scoped registry with token | `@scope:https://registry.example.com/\|$TOKEN` | `@myorg:https://npm.pkg.github.com/\|$GITHUB_TOKEN` | +| Scoped registry with URL credentials | `@scope:https://username:$PASSWORD@registry.example.com/` | `@internal:https://user:$PASS@registry.internal.com/` | > [!IMPORTANT] > When using authentication, make sure to set the corresponding environment variables in your workflow steps that need access to the registries.