Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added instructions for obtaining OpenAI API key to README #421

Conversation

vvatanabe
Copy link
Collaborator

@vvatanabe vvatanabe commented Jul 2, 2023

@sashabaranov

Describe the change
Adding instructions on how to obtain the OpenAI API key in README solves the following problems:

  1. Ease and Convenience: New developers can quickly understand how to obtain the API key, enabling them to start using the library faster.
  2. Preventing Misunderstandings: Without clear instructions, developers could potentially follow incorrect steps, leading to wasted time or potential security risks.
  3. Reducing Queries: By providing clear instructions, there's less need for developers to ask questions or make inquiries about obtaining the API key, freeing up time for the maintainers of the library.

Tests
None.

Additional context
Issue: #73

@codecov
Copy link

codecov bot commented Jul 2, 2023

Codecov Report

Merging #421 (e9eecae) into master (177c143) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #421   +/-   ##
=======================================
  Coverage   96.95%   96.95%           
=======================================
  Files          17       17           
  Lines         690      690           
=======================================
  Hits          669      669           
  Misses         15       15           
  Partials        6        6           

README.md Outdated
@@ -10,6 +10,17 @@ This library provides unofficial Go clients for [OpenAI API](https://platform.op
* DALL·E 2
* Whisper

### Getting an OpenAI API Key:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea to put this into the README, thank you! I suggest we put it just before Other examples: — installation is basic usage is probably more important to keep on the top of the README

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sashabaranov Thanks for review! I fixed it 👍

@sashabaranov sashabaranov merged commit 619ad71 into sashabaranov:master Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants