Skip to content

Commit 1d45a0d

Browse files
authored
Update the readme
1 parent 9216989 commit 1d45a0d

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Java library for Aserto services
55

66
> **Warning**
77
>
8-
> **0.20.9** is the latest version published to maven central. Versions starting with 1.0.z have been removed from maven central and are no longer available for download.
8+
> **0.21.0** is the latest version published to maven central. Versions starting with 1.0.z have been removed from maven central and are no longer available for download.
99
1010
### Build
1111
`mvn clean install`
@@ -25,14 +25,15 @@ mvn clean test
2525
```
2626

2727
### Run integration tests
28-
In order to run integration tests we need to start [topaz](https://github.com/aserto-dev/topaz)
28+
In order to run integration tests we need to have [topaz](https://github.com/aserto-dev/topaz) installed
2929
```bash
3030
go install github.com/topaz/cmd/topaz@latest
3131
topaz install
32-
topaz configure -d -s -r ghcr.io/aserto-policies/policy-todo-rebac:latest todo
33-
topaz run
3432
```
35-
and then run the integration tests
33+
34+
The integration tests start topaz and configure it for testing. The tests will fail if topaz is not installed.
35+
If you have topaz configured, no worries, the tests will save the configuration and restore it after the integration tests are finished.
36+
To run the integration tests use the fallowing command:
3637
```
3738
mvn test -Pintegration
3839
```
@@ -42,7 +43,7 @@ mvn test -Pintegration
4243
mvn clean deploy -Dgpg.passphrase="<gpg-passphrase>" -Pci-cd
4344
```
4445

45-
## Example
46+
## Authorization Example
4647
Start [topaz](https://github.com/aserto-dev/topaz)
4748

4849
```java
@@ -54,7 +55,7 @@ ManagedChannel channel = new ChannelBuilder()
5455
.build();
5556

5657
// create authz client
57-
AuthorizerClient authzClient = new AuthzClient(channel);
58+
AuthorizerClient authzClient = new AuthzClient(channel);
5859

5960
// identity context contains information abou the user that requests access to some resource
6061
IdentityCtx identityCtx = new IdentityCtx("[email protected]", IdentityType.IDENTITY_TYPE_SUB);
@@ -72,3 +73,4 @@ decisions.forEach(decision -> {
7273
System.out.println("For decision [" + dec + "] the answer was [" + isAllowed + "]");
7374
});
7475
```
76+
For more examples have a look in the [examples](examples) folder.

0 commit comments

Comments
 (0)