Skip to content

Commit 51648fb

Browse files
committed
chore: #174 Update README with versions and binary name
Signed-off-by: Laurent Broudoux <[email protected]>
1 parent 7c20ffc commit 51648fb

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,9 @@ It allows to launch tests or import API artifacts with minimal dependencies.
1313

1414
## Build Status
1515

16-
Latest release is `0.5.8`.
16+
Latest release is `1.0.0`.
1717

18-
Current development version is `0.5.9`.
19-
It is available as a container image named `quay.io/microcks/microcks-cli:nightly`.
18+
Current development version is `1.0.1`. It is available as a container image named `quay.io/microcks/microcks-cli:nightly`.
2019

2120
#### Fossa license and security scans
2221

@@ -44,11 +43,13 @@ To get involved with our community, please make sure you are familiar with the p
4443
## Usage instructions
4544

4645
### Usage
46+
4747
```bash
4848
microcks [command] [flags]
4949
```
5050

5151
### Available Commands
52+
5253
| Command | Description | Documentation |
5354
| ------------ | -------------------------------------------------------- | ----------------------------------------------- |
5455
| `login` | Log in to a Microcks instance using Keycloak credentials | [`login`](documentation/cmd/login.md) |
@@ -80,16 +81,19 @@ microcks [command] [flags]
8081

8182
### Building from Source
8283
To build the CLI locally:
84+
8385
```bash
8486
make build-local
8587
```
8688

8789
The resulting binary will be available at:
90+
8891
```bash
8992
/build/dist/microcks
9093
```
9194

9295
You can move it to a location in your $PATH for global usage, for example:
96+
9397
```bash
9498
sudo mv build/dist/microcks /usr/local/bin/microcks
9599
```
@@ -106,7 +110,7 @@ The `microcks-cli` is available as a container image. So that you'd be able to e
106110
Below a sample on how using the image without getting the CLI binary:
107111

108112
```
109-
$ docker run -it quay.io/microcks/microcks-cli:latest microcks-cli test 'Beer Catalog API:0.9' http://beer-catalog-impl-beer-catalog-dev.apps.144.76.24.92.nip.io/api/ POSTMAN --microcksURL=http://microcks.apps.144.76.24.92.nip.io/api/ --keycloakClientId=microcks-serviceaccount --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 --waitFor=8sec --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
113+
$ docker run -it quay.io/microcks/microcks-cli:latest microcks test 'Beer Catalog API:0.9' http://beer-catalog-impl-beer-catalog-dev.apps.144.76.24.92.nip.io/api/ POSTMAN --microcksURL=http://microcks.apps.144.76.24.92.nip.io/api/ --keycloakClientId=microcks-serviceaccount --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 --waitFor=8sec --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
110114
```
111115

112116

0 commit comments

Comments
 (0)