Skip to content

Commit 55f41c9

Browse files
committed
link to gemini tester
1 parent 9d9d590 commit 55f41c9

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# Introduction
2-
Java library for Gemini API.
2+
3+
Java library for Gemini API.
34
See the documentation here: https://ai.google.dev/gemini-api
45

56
# Getting started
7+
68
- Generate an API key: https://aistudio.google.com/app/apikey
79

810
# Usage
11+
912
## Dependency
13+
1014
Add the `gemini-api` dependency. Maven example (replace ${gemini.version} with the latest version):
1115

1216
<dependency>
@@ -16,8 +20,11 @@ Add the `gemini-api` dependency. Maven example (replace ${gemini.version} with t
1620
</dependency>
1721

1822
## JsonParser
19-
In order for this library to stay free of dependencies, the user must provide an implementation of the `swiss.ameri.gemini.spi.JsonParser` interface.
20-
Alternatively, an example Gson implementation can be used with the following dependency (which includes a Gson dependency)
23+
24+
In order for this library to stay free of dependencies, the user must provide an implementation of
25+
the `swiss.ameri.gemini.spi.JsonParser` interface.
26+
Alternatively, an example Gson implementation can be used with the following dependency (which includes a Gson
27+
dependency)
2128

2229
<dependency>
2330
<groupId>swiss.ameri</groupId>
@@ -27,7 +34,8 @@ Alternatively, an example Gson implementation can be used with the following dep
2734

2835
## Example code
2936

30-
See gemini-tester for some examples.
37+
See [gemini-tester](https://github.com/michael-ameri/gemini-api/blob/1beta.0.1.0/gemini-tester/src/main/java/swiss/ameri/gemini/tester/GeminiTester.java)
38+
for some examples.
3139

3240
JsonParser parser = new GsonJsonParser(); // or some custom implementation
3341
String apiKey = ...;
@@ -58,17 +66,21 @@ See gemini-tester for some examples.
5866
.forEach(System.out::println)
5967

6068
# Versioning
61-
The library versioning follows the scheme:
69+
70+
The library versioning follows the scheme:
6271
`<gemini-api-version>.<major>.<minor>.<patch>`
6372

6473
Example:
6574
`1beta.0.0.1`
6675

6776
# Requirements
77+
6878
- \>= Java 17
6979

7080
# Modules
81+
7182
The project is composed of the following maven modules, which are deployed to maven central.
83+
7284
## gemini-api
7385

7486
<dependency>
@@ -87,7 +99,7 @@ Main module to be used. Must not contain any dependencies to other modules.
8799
<version>${gemini.version}</version>
88100
</dependency>
89101

90-
Provides an example implementation of the `swiss.ameri.gemini.spi.JsonParser` class using `Gson`.
102+
Provides an example implementation of the `swiss.ameri.gemini.spi.JsonParser` class using `Gson`.
91103
Contains a maven dependency to `Gson`
92104

93105
## gemini-tester

0 commit comments

Comments
 (0)