docs: add requires go version in README.md #397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #397 +/- ##
=======================================
Coverage 95.32% 95.32%
=======================================
Files 17 17
Lines 684 684
=======================================
Hits 652 652
Misses 22 22
Partials 10 10 |
|
@sashabaranov Please check it. On a separate note, it might be beneficial to create a CONTRIBUTING.md file, issue templates, and pull request templates. These could potentially reduce communication overhead. |
README.md
Outdated
| @@ -10,6 +10,10 @@ This library provides unofficial Go clients for [OpenAI API](https://platform.op | |||
| * DALL·E 2 | |||
| * Whisper | |||
|
|
|||
| ### Requires Go: | |||
|
|
|||
| Currently, go-openai requires Go version 1.18 or greater. | |||
There was a problem hiding this comment.
Great suggestion, thank you! Maybe let's move this line to the end of the Installation section? This would help avoid extra Requires Go header and keep README short
There was a problem hiding this comment.
@sashabaranov I updated README 👍
sashabaranov
approved these changes
Jun 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'd like go-openai to declare that 1.18 or greater is required because it uses generics internally.