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

Update the README.md for v1 #138

Merged
merged 5 commits into from
Dec 2, 2023

Conversation

dvonthenen
Copy link
Contributor

@dvonthenen dvonthenen commented Dec 2, 2023

Proposed changes

This updates the README for the v1 release. This should be way simpler than before. The other version was very chatty.

Types of changes

What types of changes does your code introduce to the community Go SDK?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

Copy link
Contributor

@jpvajda jpvajda left a comment

Choose a reason for hiding this comment

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

Had some suggestions

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
dvonthenen and others added 4 commits December 1, 2023 16:47
Co-authored-by: John Vajda (JV) <[email protected]>
Co-authored-by: John Vajda (JV) <[email protected]>
Co-authored-by: John Vajda (JV) <[email protected]>
Co-authored-by: John Vajda (JV) <[email protected]>
@dvonthenen dvonthenen merged commit 0dfdbcb into deepgram:main Dec 2, 2023
1 check passed
@dvonthenen dvonthenen deleted the remove-docs-from-readme branch December 2, 2023 00:51
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