From 30e766dcee99e42cd019b76f48f81254bdd69f53 Mon Sep 17 00:00:00 2001 From: Samgu Lee Date: Mon, 17 Aug 2026 23:19:39 +0900 Subject: [PATCH] docs: update README to clarify enum keys and labels distinction --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 18cfc89..26c6e17 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,26 @@ Result: ] ``` +Get enum keys: + +```php +Status::keys(); +``` + +Result: + +```php +[ + 'draft', + 'published', +] +``` + +> **Note:** In this package, "keys" refer to the actual enum values, while "labels" are the translated display names. For example: +> +> - `keys()` returns: `['draft', 'published']` (used as identifiers) +> - `labels()` returns: `['Draft', 'Published']` (displayed to users) + Get translated options: ```php