Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cwensel committed Oct 20, 2023
1 parent f5a02b0 commit b054b09
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,22 @@ names must be unique to a region, account, or globally.
The Label class is for making labels, String for use in different contexts.

```java
Label id=Label.of("project").with("version");
Label id = Label.of("project").with("version");

id.camelCase(); // projectVersion
id.lowerHyphen(); // project-version
id.lowerColonPath(); // project:version
id.camelCase(); // projectVersion
id.lowerHyphen(); // project-version
id.lowerColonPath(); // project:version
```

There are a few flavors of Label:

- [Fixed](clusterless-commons-core/src/main/java/clusterless/commons/naming/Fixed.java) - retains the original value
- [Partition](clusterless-commons-core/src/main/java/clusterless/commons/naming/Partition.java) - allows for key=value
pairs within each path element
- [Region](clusterless-commons-core/src/main/java/clusterless/commons/naming/Region.java) - for use in AWS regions
- [Stage](clusterless-commons-core/src/main/java/clusterless/commons/naming/Stage.java) - for use to label deployment
- [Region](clusterless-commons-core/src/main/java/clusterless/commons/naming/Region.java) - for declaring AWS regions
- [Stage](clusterless-commons-core/src/main/java/clusterless/commons/naming/Stage.java) - for declaring deployment
stages
- [Version](clusterless-commons-core/src/main/java/clusterless/commons/naming/Version.java) - for use to label versions
- [Version](clusterless-commons-core/src/main/java/clusterless/commons/naming/Version.java) - for declaring versions

`Label` is an interface that can be implemented by specialized classes. Use `Label.EnumLabel` to create label enums.

Expand Down

0 comments on commit b054b09

Please sign in to comment.