Skip to content

Commit 8278d96

Browse files
committed
Add CLI usage to README
1 parent c076d64 commit 8278d96

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,15 @@ it is rather slower than JUG version: for more information, read
128128

129129
### Using JUG as CLI
130130

131-
JUG jar built under `target/` like:
131+
JUG jar built under `target/`:
132132

133133
```
134134
target/java-uuid-generator-4.1.1-SNAPSHOT.jar
135135
```
136136

137-
can be invoked directly. To see usage you can do something like:
137+
can also be used as a simple Command-line UUID generation tool.
138+
139+
To see usage you can do something like:
138140

139141
java -jar target/java-uuid-generator-4.1.1-SNAPSHOT.jar
140142

@@ -144,6 +146,11 @@ and get full instructions, but to generate 5 Random-based UUIDs, you would use:
144146

145147
(where `-c` (or `--count`) means number of UUIDs to generate, and `r` means Random-based variant)
146148

149+
NOTE: this functionality is included as of JUG 4.1 -- with earlier versions you would need a bit longer invocation as Jar metadata did not specify "Main-Class".
150+
If so, you would need to use
151+
152+
java -cp target/java-uuid-generator-4.1.1-SNAPSHOT.jar com.fasterxml.uuid.Jug -c 5 r
153+
147154
## Compatibility
148155

149156
JUG versions 3.1 and later require JDK 1.6 to work, mostly to be able to access local Ethernet MAC address.

0 commit comments

Comments
 (0)