Skip to content

Commit 828c908

Browse files
jpvajdajcdyer
andauthored
updates cargo.toml file & readme (#92)
* updates cargo.toml file & readme * Update Cargo.toml Co-authored-by: Cliff Dyer <cliff.dyer@deepgram.com> * fixes toml sytnax issue --------- Co-authored-by: Cliff Dyer <cliff.dyer@deepgram.com>
1 parent 3d2fb42 commit 828c908

File tree

2 files changed

+26
-14
lines changed

2 files changed

+26
-14
lines changed

Cargo.toml

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ authors = ["Deepgram <developers@deepgram.com>"]
55
edition = "2021"
66
description = "Official Rust SDK for Deepgram's automated speech recognition APIs."
77
license = "MIT"
8-
repository = "https://github.com/deepgram-devs/deepgram-rust-sdk"
9-
keywords = ["transcription", "voice-ai", "text-to-speech", "speech-to-text","asr"]
8+
repository = "https://github.com/deepgram/deepgram-rust-sdk"
9+
keywords = [
10+
"transcription",
11+
"voice-ai",
12+
"text-to-speech",
13+
"speech-to-text",
14+
"asr",
15+
]
1016
categories = ["api-bindings", "multimedia::audio"]
1117

1218
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -18,15 +24,21 @@ bytes = "1"
1824
futures = "0.3"
1925
http = "0.2"
2026
pin-project = "1"
21-
reqwest = { version = "0.11.22", default-features = false, features = ["json", "rustls-tls", "stream"] }
27+
reqwest = { version = "0.11.22", default-features = false, features = [
28+
"json",
29+
"rustls-tls",
30+
"stream",
31+
] }
2232
rodio = { version = "0.17.0", optional = true }
2333
serde = { version = "1.0.25", features = ["derive"] }
2434
serde_json = "1"
2535
serde_urlencoded = "0.7"
2636
thiserror = "1"
2737
tokio = { version = "1.38.0", features = ["full"] }
2838
tokio-stream = "0.1.15"
29-
tokio-tungstenite = { version = "0.20.1", features = ["rustls-tls-webpki-roots"], optional = true }
39+
tokio-tungstenite = { version = "0.20.1", features = [
40+
"rustls-tls-webpki-roots",
41+
], optional = true }
3042
tokio-util = { version = "0.7.1", features = ["codec", "io"] }
3143
tungstenite = { version = "0.20.1", optional = true }
3244
url = "2"

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
# Deepgram Rust SDK
22

3-
[![CI](https://github.com/deepgram-devs/deepgram-rust-sdk/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/deepgram-devs/deepgram-rust-sdk/actions/workflows/ci.yaml)
3+
[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4)
4+
[![CI](https://github.com/deepgram/deepgram-rust-sdk/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/deepgram/deepgram-rust-sdk/actions/workflows/ci.yaml)
45
[![crates.io](https://img.shields.io/crates/v/deepgram)](https://crates.io/crates/deepgram)
56
[![downloads](https://img.shields.io/crates/d/deepgram)](https://crates.io/crates/deepgram)
67
[![docs](https://img.shields.io/docsrs/deepgram)](https://docs.rs/deepgram)
78
[![license](https://img.shields.io/crates/l/deepgram)](./LICENSE)
89

9-
Experimental Rust SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models.
10+
A Community Rust SDK for [Deepgram](https://www.deepgram.com/). Start building with our powerful transcription & speech understanding API.
1011

11-
> This SDK only supports hosted usage of api.deepgram.com.
12+
## SDK Documentation
13+
14+
This SDK implements the Deepgram API found at [https://developers.deepgram.com](https://developers.deepgram.com).
15+
16+
Documentation and examples can be found on our [Docs.rs page](https://docs.rs/deepgram/latest/deepgram/).
1217

1318
## Getting an API Key
1419

1520
🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
16-
## Documentation
1721

18-
You can learn more about the Deepgram API at [developers.deepgram.com](https://developers.deepgram.com/docs).
1922

2023
## Current Status
2124

22-
This SDK is still very much work-in-progress. The interface is subject to rapid change.
25+
This SDK is currently Community owned but is moving to a stable `1.0` version soon.
26+
2327
## Install
2428

2529
From within your Cargo project directory, run the following command:
@@ -34,10 +38,6 @@ You will also probably need to install [`tokio`](https://crates.io/crates/tokio)
3438
cargo add tokio --features full
3539
```
3640

37-
## Documentation and Examples
38-
39-
Documentation and examples can be found on our [Docs.rs page](https://docs.rs/deepgram/latest/deepgram/).
40-
4141
## Development and Contributing
4242

4343
Interested in contributing? We ❤️ pull requests!

0 commit comments

Comments
 (0)