Skip to content

Commit

Permalink
Add Usage in README
Browse files Browse the repository at this point in the history
  • Loading branch information
0xinhua committed Jun 14, 2024
1 parent a77bb6c commit ea442f1
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,34 @@
</a>

<p align="center">
An beautiful open-source AI chatbot built with Next.js, the Vercel AI SDK, OpenAI, and Vercel KV.
A beautiful, customizable AI chatbot built with Next.js, Vercel AI SDK, OpenAI, and Supabase.
</p>

<p align="center">
<a href="#features"><strong>Features</strong></a> ·
<a href="#stacks"><strong>Stacks</strong></a> ·
<a href="#model-providers"><strong>Model Providers</strong></a> ·
<a href="#deploy-your-own"><strong>Deploy Your Own</strong></a> ·
<a href="#running-locally"><strong>Running locally</strong></a> ·
<a href="#authors"><strong>Authors</strong></a>
<a href="#thanks"><strong>Thanks</strong></a>
</p>
<br/>

## Usage

👋 Hey, you can use [joychat.io](https://joychat.io/) for **Free** as long as my OpenAI key quota allows it. If it exceeds what I can afford later, I will consider limiting frequency of use.

## Stacks

- [Next.js](https://nextjs.org) App Router
- [Supabase](https://supabase.com/) for Database
- [Vercel AI SDK](https://sdk.vercel.ai/docs) for streaming chat UI
- Support for OpenAI (default), Anthropic, Cohere, Hugging Face, or custom AI chat models and/or LangChain
- [shadcn/ui](https://ui.shadcn.com)
- Styling with [Tailwind CSS](https://tailwindcss.com)
- [Radix UI](https://radix-ui.com) for headless component primitives
- Styling with [shadcn/ui](https://ui.shadcn.com) and [Tailwind CSS](https://tailwindcss.com)
- [NextAuth.js](https://github.com/nextauthjs/next-auth) for authentication

## Model Providers

This template ships with OpenAI `gpt-3.5-turbo` as the default. However, you can switch LLM providers to [Anthropic](https://anthropic.com), [Cohere](https://cohere.com/), [Hugging Face](https://huggingface.co), or using [LangChain](https://js.langchain.com) with just a few lines of code.
This chatbot ships with OpenAI `gpt-4o` as the default. However, you can switch LLM providers to [Anthropic](https://anthropic.com), [Cohere](https://cohere.com/), [Hugging Face](https://huggingface.co), or using [LangChain](https://js.langchain.com) with just a few lines of code.

## Deploy Your Own

Expand Down

0 comments on commit ea442f1

Please sign in to comment.