Skip to content
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

Jump to bottom

Add description and other examples #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add description and other examples #29

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
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ This repository contains examples of how to use the [Hume API](https://docs.hume
| [`typescript-streaming-sandbox`](./typescript-streaming-sandbox/README.md) | `language`, `face`, `burst`, `speech` | Typescript | Next.js |
| [`visualization-example`](./visualization-example/example-notebook.ipynb) | `face` | Python | |


## [Empathic Voice Interface (EVI)](https://dev.hume.ai/docs/empathic-voice-interface-evi/overview)

| Name | Language | Framework |
| ------------------------------------------------------------------- | ---------- | ---------- |
| [`evi-typescript-example`](/evi-typescript-example/README.md) | Typescript | Vanilla JS |
| [`evi-custom-language-model`](/evi-custom-language-model/README.md) | Python | |
| [`meld`](/meld/README.md) | Typescript | React |
| Name | Language | Framework | Description |
| ------------------------------------------------------------------- | ---------- | ---------- | ----------- |
| [`evi-typescript-example`](/evi-typescript-example/README.md) | Typescript | Vanilla JS | |
| [`evi-custom-language-model`](/evi-custom-language-model/README.md) | Python | | |
| [`meld`](/meld/README.md) | Typescript | React | |
| [`next-app`](https://github.com/HumeAI/empathic-voice-api-js/tree/main/examples/next-app) | Typescript | Next.js | |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jerhadf
These are shell apps within the empathic-voice-api-js monorepo. (The purpose of these shell apps are to test packages published from the monorepo locally)

There is some work to be done to make these into example apps which serve as external developer resources:

  1. Update project names to reflect what they are an example of.
  2. Update project READMEs to include: descriptions of what the apps are and what they do, env setup instructions, instructions to build/run the projects, and instructions for usage.
  3. Comments throughout the code which act as documentation for the code, explaining various steps is also really good to have— but can be added later based on developer feedback (like when something is called out as unclear)

| [`vite-app-embed`](https://github.com/HumeAI/empathic-voice-api-js/tree/main/examples/vite-app-embed) | Typescript | Vite | |
| [`vite-app`](https://github.com/HumeAI/empathic-voice-api-js/tree/main/examples/vite-app) | Typescript | Vite | |