Repository navigation
docs: get the repo ready to go public - #4
Merged
Merged
Conversation
- README: npm and license badges, yarn/bun install, ws only for Node realtime, options win over env vars, exported types, requirements (Node 18+, TS 4.7+), getting help and security sections - SECURITY.md: report vulnerabilities privately through GitHub - tests: use placeholder hosts instead of the internal dev API host
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prepares the repo for going public.
Secrets audit: gitleaks over all history and the working tree found no real secrets (one hit is a fake test token). The internal dev API host is removed from the tests; it remains in older commits.
README, filling the gaps found by comparing against openai-node, Deepgram, ElevenLabs, Cartesia, LMNT and Fern/Stainless conventions:
wsonly needed for realtime in NodeSECURITY.md: report vulnerabilities privately through GitHub's private vulnerability reporting (to be enabled once the repo is public).
pnpm typecheck,pnpm lintandpnpm testpass (156 tests).