Skip to content

Commit

Permalink
docs: update readme (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
altaywtf authored Dec 17, 2023
1 parent a21ad5f commit bee4d4f
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
</p>

<p>
<a href="https://supabase.io" target="_blank"><img src="https://shields.io/badge/supabase-black?logo=supabase"></a>
<a href="https://vercel.com" target="_blank"><img src="https://img.shields.io/badge/Vercel-black?style=flat&logo=Vercel&logoColor=white"></a>
<a href="https://conventionalcommits.org" target="_blank"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196" ></a>
<img src="https://img.shields.io/github/license/experiment-station/beecast">
</p>
Expand All @@ -25,29 +23,42 @@

## Introduction

beecast is a simple yet effective tool designed to integrate with your Spotify account, enhancing your podcast experience with accessible transcriptions and summarizations.
beecast is a simple yet effective tool that enhances your podcast experience with AI powered summarizations.

Our aim is to provide a user-friendly platform that simplifies the way people interact with their favorite podcasts, especially for those looking to consume content in a more efficient manner.

## How it works

Here's a quick overview of beecast's features:

- Log in with GitHub: Use your GitHub account to sign in to beecast.
- Discover podcasts: Browse through the curated list of podcasts and add them to your library. These podcasts are currently imported via our Spotify accounts.
- Listen to podcasts: Listen to your favorite podcasts with the added benefits of AI-generated transcriptions and summaries.

### Upcoming features

Our initial idea was to use Spotify's API, but they have a six-week review process for new apps. We're planning to implement the following features once we get approved:

- Spotify integration: Log in with your Spotify account to sync your podcast library to beecast.
- Podcast matching: We match your podcasts with entries from the Podcast Index.
- Interactive features: Enjoy listening to episodes with the added benefits of AI-generated transcriptions and summaries.
- Seamless continuation: beecast remembers where you left off, allowing for an uninterrupted listening experience.

## Tech stack

We are using the following technologies to build beecast:

- Next.js as the full-stack framework.
- Radix Themes for the UI.
- Supabase Auth for user authentication.
- Supabase Database for the database.
- Spotify API for fetching user data, Podcast Index for podcast cataloging.
- Deepgram's SDK for transcription, OpenAI SDK for summarization.
- [Graphite](https://graphite.dev/) for the stacked PRs.
- [Next.js](https://nextjs.org/) as the full-stack framework.
- [Radix Themes](https://www.radix-ui.com/) for the UI.
- [Supabase Auth](https://supabase.com/docs/guides/auth) for user authentication via GitHub and Spotify.
- [Spotify API](https://developer.spotify.com/) for fetching user's podcasts.
- [Podcast Index API](https://github.com/Podcastindex-org) for fetching podcast metadata.
- [Supabase Database](https://supabase.com/docs/guides/database/overview) for the database.
- [Deepgram SDK](https://deepgram.com/) for transcription.
- [OpenAI SDK](https://platform.openai.com) for summarization.
- [Vercel AI SDK](https://sdk.vercel.ai/) for streaming the OpenAI response.
- [Sentry](https://sentry.io/) for error tracking.
- [Baselime](https://baselime.io/) for monitoring.

## Team

Expand Down

0 comments on commit bee4d4f

Please sign in to comment.