deepgram / deepgram-js-sdk

Official JavaScript SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
127 stars 45 forks source link

Nit: readme edits - directory paths, example run commands #244

Open jkroll-deepgram opened 4 months ago

jkroll-deepgram commented 4 months ago

What is the current behavior?

What's happening that seems wrong?

1.

In the readme:

Change directories
Move into the examples project directory for either the prerecorded or the streaming example projects:

cd examples/prerecorded

The structure is currently examples/node-live, examples/node-prerecorded, examples/node-read. There are not prerecorded and streaming example projects.

2.

There isn't a basic command on how to run the examples. I have no JavaScript skills and I google for everything I need. We should put the 101 level commands in the readme too.

If you simply add in node index.js as the command for running the tutorials, that would be wonderful!

Steps to reproduce

To make it faster to diagnose the root problem. Tell us how can we reproduce the bug.

Expected behavior

What would you expect to happen when following the steps above?

Both require minor readme edits.

Please tell us about your environment

We want to make sure the problem isn't specific to your operating system or programming language.

Other information

Anything else we should know? (e.g. detailed explanation, stack-traces, related issues, suggestions how to fix, links for us to have context, eg. stack overflow, codepen, etc)

lukeocodes commented 4 months ago

Great feedback, thank you!

I love how David has documented the examples on the other SDK, so I may take and use his format