Skip to content

Commit

Permalink
upd README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gertd committed Jun 25, 2024
1 parent c916bc2 commit 601405c
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,37 @@

[![slack](https://img.shields.io/badge/slack-Aserto%20Community-brightgreen)](https://asertocommunity.slack.com)

Java GRPC bindings for aserto directory. Those are raw bindings, for a better developer experience we recommend you use [aserto-java](https://github.com/aserto-dev/aserto-java) or [aserto-spring](https://github.com/aserto-dev/aserto-spring) if your project already uses Spring.
Generated Java gRPC bindings for the Topaz and Aserto Directory Service; these are low-level bindings.
For a more idiomatic Java development experience, we advise using the [aserto-java](https://github.com/aserto-dev/aserto-java) or [aserto-spring](https://github.com/aserto-dev/aserto-spring) when your project is using Spring.


## Requirements
- [buf cli](https://docs.buf.build/installation)
- GNU make
- [maven](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)
- java 1.8 or newer
- Java 8 or newer

If you need to regenerate the protobuf binding you will also need the:
- [buf cli](https://docs.buf.build/installation), which will be installed by using `make deps`

### Building the project
```bash
make build
```

or

```bash
mvn clean package
```

If you want to install the package to your local maven repository in order to include it in other projects

```bash
make install
```

or

```bash
mvn clean install
```

0 comments on commit 601405c

Please sign in to comment.