Skip to content

Commit 93e942e

Browse files
committed
be more precise in readme
1 parent 3bcc5e3 commit 93e942e

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<div align="center">
22

33
# ChatGPT Java API
4-
[![](https://img.shields.io/github/v/release/CJCrafter/ChatGPT-Java-API)](https://github.com/CJCrafter/ChatGPT-Java-API/releases/latest)
5-
[![](https://img.shields.io/badge/-docs%20-blueviolet)](https://openai.cjcrafter.com/)
6-
[![](https://img.shields.io/badge/-examples%20-orange)](https://github.com/CJCrafter/ChatGPT-Java-API/wiki)
4+
[![Maven Central](https://img.shields.io/maven-central/v/com.cjcrafter/openai?color=blue&label=Download)](https://central.sonatype.com/namespace/com.cjcrafter)
5+
[![](https://img.shields.io/badge/-docs%20-blueviolet?logo=Kotlin&colorA=gray)](https://openai.cjcrafter.com/)
6+
[![](https://img.shields.io/badge/-examples%20-orange?logo=Read+The+Docs&colorA=gray)](https://github.com/CJCrafter/ChatGPT-Java-API/wiki)
77
[![](https://img.shields.io/github/discussions/CJCrafter/ChatGPT-Java-API)](https://github.com/CJCrafter/ChatGPT-Java-API/discussions)
88
[![License](https://img.shields.io/github/license/WeaponMechanics/ArmorMechanics)](https://github.com/WeaponMechanics/ArmorMechanics/blob/master/LICENSE)
99

10-
A community maintained easy-to-use Java/Kotlin OpenAI API for ChatGPT, Text Completions, and more!
10+
A community-maintained easy-to-use Java/Kotlin OpenAI API for ChatGPT, Text Completions, and more!
1111
</div>
1212

1313
## Features
@@ -84,11 +84,13 @@ public class JavaChatTest {
8484
}
8585
}
8686
}
87-
8887
```
88+
> **Note**: OpenAI recommends using environment variables for your API token
89+
([Read more](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)).
8990

9091
## Support
9192
If I have saved you time, please consider [sponsoring me](https://github.com/sponsors/CJCrafter).
9293

9394
## License
94-
ChatGPT-Java-API is licensed under the [MIT License](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/LICENSE).
95+
ChatGPT-Java-API is an open-sourced software licensed under the [MIT License](https://github.com/CJCrafter/ChatGPT-Java-API/blob/master/LICENSE).
96+
**This is an unofficial library, and is not affiliated with OpenAI**.

0 commit comments

Comments
 (0)