From 828c908c000c2eeb93601e3efe52fb98661c2c0b Mon Sep 17 00:00:00 2001 From: "John Vajda (JV)" Date: Fri, 23 Aug 2024 16:37:43 -0600 Subject: [PATCH] updates cargo.toml file & readme (#92) * updates cargo.toml file & readme * Update Cargo.toml Co-authored-by: Cliff Dyer * fixes toml sytnax issue --------- Co-authored-by: Cliff Dyer --- Cargo.toml | 20 ++++++++++++++++---- README.md | 20 ++++++++++---------- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 2594fb58..750730fa 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,8 +5,14 @@ authors = ["Deepgram "] edition = "2021" description = "Official Rust SDK for Deepgram's automated speech recognition APIs." license = "MIT" -repository = "https://github.com/deepgram-devs/deepgram-rust-sdk" -keywords = ["transcription", "voice-ai", "text-to-speech", "speech-to-text","asr"] +repository = "https://github.com/deepgram/deepgram-rust-sdk" +keywords = [ + "transcription", + "voice-ai", + "text-to-speech", + "speech-to-text", + "asr", +] categories = ["api-bindings", "multimedia::audio"] # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -18,7 +24,11 @@ bytes = "1" futures = "0.3" http = "0.2" pin-project = "1" -reqwest = { version = "0.11.22", default-features = false, features = ["json", "rustls-tls", "stream"] } +reqwest = { version = "0.11.22", default-features = false, features = [ + "json", + "rustls-tls", + "stream", +] } rodio = { version = "0.17.0", optional = true } serde = { version = "1.0.25", features = ["derive"] } serde_json = "1" @@ -26,7 +36,9 @@ serde_urlencoded = "0.7" thiserror = "1" tokio = { version = "1.38.0", features = ["full"] } tokio-stream = "0.1.15" -tokio-tungstenite = { version = "0.20.1", features = ["rustls-tls-webpki-roots"], optional = true } +tokio-tungstenite = { version = "0.20.1", features = [ + "rustls-tls-webpki-roots", +], optional = true } tokio-util = { version = "0.7.1", features = ["codec", "io"] } tungstenite = { version = "0.20.1", optional = true } url = "2" diff --git a/README.md b/README.md index 51cd4034..da2743f6 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,29 @@ # Deepgram Rust SDK -[![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) +[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) +[![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) [![crates.io](https://img.shields.io/crates/v/deepgram)](https://crates.io/crates/deepgram) [![downloads](https://img.shields.io/crates/d/deepgram)](https://crates.io/crates/deepgram) [![docs](https://img.shields.io/docsrs/deepgram)](https://docs.rs/deepgram) [![license](https://img.shields.io/crates/l/deepgram)](./LICENSE) -Experimental Rust SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models. +A Community Rust SDK for [Deepgram](https://www.deepgram.com/). Start building with our powerful transcription & speech understanding API. -> This SDK only supports hosted usage of api.deepgram.com. +## SDK Documentation + +This SDK implements the Deepgram API found at [https://developers.deepgram.com](https://developers.deepgram.com). + +Documentation and examples can be found on our [Docs.rs page](https://docs.rs/deepgram/latest/deepgram/). ## Getting an API Key 🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys). -## Documentation -You can learn more about the Deepgram API at [developers.deepgram.com](https://developers.deepgram.com/docs). ## Current Status -This SDK is still very much work-in-progress. The interface is subject to rapid change. +This SDK is currently Community owned but is moving to a stable `1.0` version soon. + ## Install 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) cargo add tokio --features full ``` -## Documentation and Examples - -Documentation and examples can be found on our [Docs.rs page](https://docs.rs/deepgram/latest/deepgram/). - ## Development and Contributing Interested in contributing? We ❤️ pull requests!