Skip to content

Commit bdbb5fa

Browse files
committed
docs: update README to clarify secret referencing syntax and add cross-application reference example
1 parent 6920369 commit bdbb5fa

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ The Phase Secrets SDK provides a Go package for managing secrets in your applica
1010

1111
### Secret Referencing Syntax
1212

13-
| Reference Syntax | Environment | Path | Secret Key | Description |
14-
|-----------------------------------|------------------|-----------------------------------|------------------------|-------------------------------------------------------------|
15-
| `${KEY}` | Same environment | `/` | KEY | Local reference in the same environment and root path (/). |
16-
| `${staging.DEBUG}` | `staging` | `/` (root of staging environment) | DEBUG | Cross-environment reference to a secret at the root (/). |
17-
| `${prod./frontend/SECRET_KEY}` | `prod` | `/frontend/` | SECRET_KEY | Cross-environment reference to a secret in a specific path. |
18-
| `${/backend/payments/STRIPE_KEY}` | Same environment | `/backend/payments/` | STRIPE_KEY | Local reference with a specified path. |
13+
| Reference Syntax | Application | Environment | Path | Secret Key | Description |
14+
|-------------------------------------------|------------------|------------------|-----------------------------------|------------------------|-------------------------------------------------------------|
15+
| `${KEY}` | Same application | Same environment | `/` | KEY | Local reference in the same environment and root path (/). |
16+
| `${staging.DEBUG}` | Same application | `staging` | `/` (root of staging environment) | DEBUG | Cross-environment reference to a secret at the root (/). |
17+
| `${prod./frontend/SECRET_KEY}` | Same application | `prod` | `/frontend/` | SECRET_KEY | Cross-environment reference to a secret in a specific path. |
18+
| `${/backend/payments/STRIPE_KEY}` | Same application | Same environment | `/backend/payments/` | STRIPE_KEY | Local reference with a specified path. |
19+
| `${backend_api::production./frontend/KEY}` | `backend_api` | `production` | `/frontend/` | KEY | Cross-application reference to a secret in a specific path. |
1920

2021
## Installation
2122

0 commit comments

Comments
 (0)