feat: added .env.example file #30
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
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.
Hi Speechmatics team!
I've been testing the API and found what I think is a small area for improvement.
After reading this part of the README: "To run the node sample code you'll need to add your API key to a
.envfile".I was faced with this little problem: "How do I name the API env variable?".
This made me take the extra step of opening the
example_rt_node.jsfile and searching for "API".I believe adding the
.env.examplefile will make it a bit easier for new developers to get started.I'm not sure if
MP_API_KEYshould be included though.😄 Anyway, Merry Christmas everyone!