Skip to content

Commit 83fd773

Browse files
committed
PCG/CLI readme updates for cli binaries
1 parent bca82f0 commit 83fd773

3 files changed

Lines changed: 17 additions & 2 deletions

File tree

pcgroups-cli/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44

55
The Partitioned Consumer Groups CLI is a command line tool. In the usage,
66

7+
[![0.1.0](https://img.shields.io/badge/Current_Release-0.1.0-27AAE0)](https://github.com/synadia-io/orbit.java/releases/tag/pcgcli%2F0.1.0)
8+
9+
#### Downloads
10+
11+
| tar | zip |
12+
|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
13+
| [cg.tar](https://github.com/synadia-io/orbit.java/releases/download/pcgcli%2F0.1.0/cg.tar) | [cg.zip](https://github.com/synadia-io/orbit.java/releases/download/pcgcli%2F0.1.0/cg.zip) |
14+
15+
## Usage
16+
717
`cg` stands for `java -jar <path>/cg.jar`
818

919
```

pcgroups-cli/build.gradle

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ tasks.register('createZip', Zip) {
4949

5050
archiveFileName = "cg.zip"
5151
destinationDirectory = file('build/')
52-
from (files('build/cg.jar'))
52+
from (files('README.md', 'build/cg.jar'))
5353
}
5454

5555
tasks.register('createTar', Tar) {
5656
dependsOn 'package'
5757

5858
archiveFileName = "cg.tar"
5959
destinationDirectory = file('build/')
60-
from (files('build/cg.jar'))
60+
from (files('README.md', 'build/cg.jar'))
6161
}
6262

6363
tasks.register('dist') {

pcgroups/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@ This `cg` CLI tool can be used by passing it commands and arguments directly, or
6464

6565
For more details on the CLI visit the [Partitioned Consumer Groups CLI Project](https://github.com/synadia-io/orbit.java/tree/main/pcgroups-cli)
6666

67+
### Binaries
68+
You can download the latest `cg.jar` archived in a tar file
69+
[cg.tar](https://github.com/synadia-io/orbit.java/releases/download/pcgcli%2F0.1.0/cg.tar)
70+
or zip file
71+
[cg.zip](https://github.com/synadia-io/orbit.java/releases/download/pcgcli%2F0.1.0/cg.zip)
6772

6873
## Demo walkthrough
6974

0 commit comments

Comments
 (0)