Skip to content

Fix DESCRIPTION for CRAN submission #4

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.

Sign up for GitHub

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

Merged
TroyHernandez merged 1 commit into from
Mar 18, 2026
Merged

Fix DESCRIPTION for CRAN submission #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
Package: stt.api
Title: OpenAI-Compatible Speech-to-Text API Client
Title: 'OpenAI' Compatible Speech-to-Text API Client
Version: 0.1.0
Authors@R:
person("Troy", "Hernandez", email = "troy@cornball.ai", role = c("aut", "cre"))
Description: A minimal-dependency R client for OpenAI-compatible Speech-to-Text
APIs with optional local fallbacks. Supports OpenAI, local servers
(LM Studio, OpenWebUI, Whisper containers), and the audio.whisper package.
Description: A minimal-dependency R client for 'OpenAI'-compatible Speech-to-Text
APIs with optional local fallbacks. Supports 'OpenAI', local servers
('LM Studio', 'OpenWebUI', 'Whisper' containers), and the 'audio.whisper'
package.
License: MIT + file LICENSE
Encoding: UTF-8
URL: https://github.com/cornball-ai/stt.api
Expand All @@ -14,9 +15,6 @@ Imports:
curl,
jsonlite
Suggests:
audio.whisper,
gpu.ctl,
processx,
tinytest,
whisper
RoxygenNote: 7.3.3
17 changes: 1 addition & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Optional backends:

* `{whisper}` (recommended, on CRAN)
* `{audio.whisper}` (whisper.cpp alternative)
* `{processx}` (Docker helpers)


---

Expand Down Expand Up @@ -163,21 +163,6 @@ This is intentionally chosen because it is:

---

## Docker (optional)

If you run Whisper or OpenAI-compatible STT in Docker, `stt.api` can optionally integrate via `{processx}`.

Example use cases:

* Starting a local Whisper container
* Checking container health
* Inspecting logs

Docker helpers are **explicit and opt-in**.
`stt.api` never starts containers automatically.

---

## Configuration options

```r
Expand Down