search

speechmatics / speechmatics-js-sdk

Javascript and Typescript SDK for Speechmatics
MIT License
39 stars 4 forks source link

feat: added .env.example file #30

Closed kurama3322 closed 6 months ago

kurama3322 commented 6 months ago

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 .env file". 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.js file and searching for "API".

I believe adding the .env.example file will make it a bit easier for new developers to get started.

I'm not sure if MP_API_KEY should be included though.

😄 Anyway, Merry Christmas everyone!

nickgerig commented 6 months ago

Thanks @kurama3322 - good suggestion!