readme amended

[thomasek]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the project's README file by providing additional information on prerequisites, build instructions, dependency configurations, and clarifications on gRPC job worker functionality. These changes aim to improve the user experience by guiding them through the setup and usage of the ZenBPM Java Client.

Highlights

• Documentation Enhancement: The primary focus of this pull request is to improve the project's documentation by adding prerequisites for running the application, providing instructions for incorporating job workers, and clarifying the job worker execution process.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request updates the README file to provide more information for users, including prerequisites and optional dependencies. My review focuses on improving the clarity and consistency of the documentation, with suggestions to correct a typo, format URLs as proper links, and standardize code snippet formatting.

[gemini-code-assist]

There is a typo in the heading 'Prerequisities'; it should be 'Prerequisites'. For consistency with other headings in the document, the trailing colon should be removed. Additionally, formatting the URLs as Markdown links would improve readability.

Suggested change

	## Prerequisities:
	You need to have a running instance of ZenBPM (https://github.com/pbinitiative/zenbpm/pkgs/container/zenbpm) and ideally also a running instance of ZenBPM UI https://github.com/orgs/pbinitiative/packages/container/package/zenbpm-ui.
	## Prerequisites
	You need to have a running instance of [ZenBPM](https://github.com/pbinitiative/zenbpm/pkgs/container/zenbpm) and ideally also a running instance of [ZenBPM UI](https://github.com/orgs/pbinitiative/packages/container/package/zenbpm-ui).

[gemini-code-assist]

For better readability and professionalism, the introductory sentence should be a complete sentence starting with a capital letter. Also, the indentation within the XML code block is inconsistent. Applying consistent indentation improves code readability.

Suggested change

	if you are planning to use job workers, add also
	```xml
	<dependency>
	<groupId>io.grpc</groupId>
	<artifactId>grpc-netty-shaded</artifactId>
	<version>1.80.0</version>
	</dependency>
	```
	If you are planning to use job workers, add the following dependency as well:
	```xml
	<dependency>
	<groupId>io.grpc</groupId>
	<artifactId>grpc-netty-shaded</artifactId>
	<version>1.80.0</version>
	</dependency>