Skip to content

Commit b4849f6

Browse files
authored
chore: readme updates (#93)
1 parent 16cc47a commit b4849f6

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/deepgram/deepgram-python-sdk/CI)](https://github.com/deepgram/deepgram-python-sdk/actions/workflows/CI.yml) [![PyPI](https://img.shields.io/pypi/v/deepgram-sdk)](https://pypi.org/project/deepgram-sdk/) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](./.github/CODE_OF_CONDUCT.md)
44

5-
Official Python SDK for [Deepgram](https://www.deepgram.com/?utm_medium=github&utm_source=devrel&utm_content=deepgram-python-sdk)'s automated speech recognition APIs.
5+
Official Python SDK for [Deepgram](https://www.deepgram.com/). Start building with our powerful transcription & speech understanding API.
66

7-
To access the API you will need a Deepgram account. Sign up for free at
8-
[console.deepgram.com](https://console.deepgram.com/signup?utm_medium=github&utm_source=devrel&utm_content=deepgram-python-sdk).
7+
> This SDK only supports hosted usage of api.deepgram.com.
8+
## Getting an API Key
99

10-
You can learn more about the full Deepgram API at [developers.deepgram.com](https://developers.deepgram.com).
10+
🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
11+
## Documentation
12+
13+
Complete documentation of the Python SDK can be found at [Deepgram Docs](https://developers.deepgram.com/docs/python-sdk).
14+
15+
You can learn more about the Deepgram API at [developers.deepgram.com](https://developers.deepgram.com/docs).
1116

1217
## Getting Started
1318

@@ -95,7 +100,7 @@ async def main():
95100

96101
# Listen for any transcripts received from Deepgram and write them to the console
97102
deepgramLive.registerHandler(deepgramLive.event.TRANSCRIPT_RECEIVED, print)
98-
103+
99104
# Listen for the connection to open and send streaming audio from the URL to Deepgram
100105
async with aiohttp.ClientSession() as session:
101106
async with session.get(URL) as audio:
@@ -138,8 +143,6 @@ In the `sample-projects` folder, there are examples from four different Python w
138143
- Django
139144
- Quart
140145

141-
Each of the examples has a README file you can follow to set up and run your project. If you get stuck, please feel free to Tweet us! We're [@DeepgramAI on Twitter](https://twitter.com/DeepgramAI)
142-
143146
## Development and Contributing
144147

145148
Interested in contributing? We ❤️ pull requests!
@@ -153,9 +156,8 @@ To make sure our community is safe for all, be sure to review and agree to our
153156
We love to hear from you so if you have questions, comments or find a bug in the
154157
project, let us know! You can either:
155158

156-
- [Open an issue](https://github.com/deepgram/deepgram-python-sdk/issues/new) on this repository
157-
- Tweet at us! We're [@DeepgramAI on Twitter](https://twitter.com/DeepgramAI)
158-
159-
## Further Reading
159+
- [Open an issue in this repository](https://github.com/deepgram/deepgram-python-sdk/issues/new)
160+
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
161+
- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
160162

161-
Check out the Developer Documentation at [https://developers.deepgram.com/](https://developers.deepgram.com/)
163+
[license]: LICENSE.txt

0 commit comments

Comments
 (0)