diff --git a/README.md b/README.md index c403366..bab071f 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,46 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +
+

+ +

-## Getting Started +

Beecast

-First, run the development server: +

+ Your hard-working AI podcast companion. +

+
-```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +--- -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## Introduction -## Learn More +Beecast is a simple yet effective tool designed to integrate with your Spotify account, enhancing your podcast experience with accessible transcriptions and 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. -To learn more about Next.js, take a look at the following resources: +## How it works -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +Here's a quick overview of Beecast's features: -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +- Spotify integration: Log in with your Spotify account to sync your podcast library. +- Podcast matching: We match your podcasts with entries from the Open 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. -## Deploy on Vercel +## Tech stack -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +We are using the following technologies to build Beecast: -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +- 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, Open Podcast Index for podcast matching. +- Deepgram's SDK for transcription, OpenAI SDK for summarization. + +## Team + +- [Okan](https://github.com/okanisildar) +- [Altay](https://github.com/altaywtf)