update readme

README.md

@@ -5,23 +5,32 @@ A flexible, scalable and customizable agent to do your bidding.
 ![cj](https://github.com/lalalune/bgent/assets/18633264/7513b5a6-2352-45f3-8b87-7ee0e2171a30)
 
 [![npm version](https://badge.fury.io/js/bgent.svg)](https://badge.fury.io/js/bgent)
+![build passing](https://github.com/JoinTheAlliance/bgent/actions/workflows/deploy_worker.yaml/badge.svg)
 [![License](https://img.shields.io/badge/License-MIT-blue)](https://github.com/lalalune/bgent/blob/main/LICENSE)
 [![stars - bgent](https://img.shields.io/github/stars/lalalune/bgent?style=social)](https://github.com/lalalune/bgent)
 [![forks - bgent](https://img.shields.io/github/forks/lalalune/bgent?style=social)](https://github.com/lalalune/bgent)
 
-## Join Us On Discord
+## Connect With Us
 
 [![Join the Discord server](https://dcbadge.vercel.app/api/server/qetWd7J9De)](https://discord.gg/qetWd7J9De)
 
 ## Features
 
-- Simple and extensible
-- Customizable to your use case
-- Retrievable memory and document store
-- Serverless artchitecture, deployable in minutes at scale with Cloudflare and Supabase
-- Multi-agent and room support
-- Summarization and summarization
-- Goal-directed behavior
+- 🛠 Simple and extensible
+- 🎨 Customizable to your use case
+- 📚 Easily ingest and interact with your documents
+- 💾 Retrievable memory and document store
+- ☁️ Serverless architecture
+- 🚀 Deployable in minutes at scale with Cloudflare
+- 👥 Multi-agent and room support
+- 🎯 Goal-directed behavior
+- 📦 Comes with ready-to-deploy examples
+
+## What can I use it for?
+- 🤖 Chatbots
+- 🕵️ Autonomous Agents
+- 📈 Business process handling
+- 🎮 Video game NPCs
 
 ## Try the agent
 
@@ -61,21 +70,35 @@ supabase start
 
 You can now start the bgent project with `npm run dev` and it will connect to the local Supabase instance by default.
 
+**NOTE**: You will need Docker installed for this to work. If that is an issue for you, use the _Supabase Cloud Setup_ instructions instead below).
+
 ### Supabase Cloud Setup
 
 This library uses Supabase as a database. You can set up a free account at [supabase.io](https://supabase.io) and create a new project.
 
-- Step 1: On the Subase All Projects Dashboard, select “New Project”.  
-- Step 2: Select the organization to store the new project in, assign a database name, password and region.  
-- Step 3: Select “Create New Project”.  
-- Step 4: Wait for the database to setup. This will take a few minutes as supabase setups various directories.  
-- Step 5: Select the “SQL Editor” tab from the left navigation menu.  
-- Step 6: Copy in your own SQL dump file or optionally use the provided file in the bgent directory at: "src/supabase/db.sql". Note: You can use the command "supabase db dump" if you have a pre-exisiting supabase database to generate the SQL dump file.  
-- Step 7: Paste the SQL code into the SQL Editor and hit run in the bottom right.  
+- Step 1: On the Subase All Projects Dashboard, select “New Project”.
+- Step 2: Select the organization to store the new project in, assign a database name, password and region.
+- Step 3: Select “Create New Project”.
+- Step 4: Wait for the database to setup. This will take a few minutes as supabase setups various directories.
+- Step 5: Select the “SQL Editor” tab from the left navigation menu.
+- Step 6: Copy in your own SQL dump file or optionally use the provided file in the bgent directory at: "src/supabase/db.sql". Note: You can use the command "supabase db dump" if you have a pre-exisiting supabase database to generate the SQL dump file.
+- Step 7: Paste the SQL code into the SQL Editor and hit run in the bottom right.
 - Step 8: Select the “Databases” tab from the left navigation menu to verify all of the tables have been added properly.
 
 Once you've set up your Supabase project, you can find your API key by going to the "Settings" tab and then "API". You will need to set the `SUPABASE_URL` and `SUPABASE_SERVICE_API_KEY` environment variables in your `.dev.vars` file.
 
+## Local Model Setup
+
+While bgent uses ChatGPT 3.5 by default, you can use a local model by setting the `serverUrl` to a local endpoint. The [LocalAI](https://localai.io/) project is a great way to run a local model with a compatible API endpoint.
+
+```typescript
+const runtime = new BgentRuntime({
+  serverUrl: process.env.LOCALAI_URL,
+  token: process.env.LOCALAI_TOKEN, // Can be an API key or JWT token for your AI service
+  // ... other options
+});
+```
+
 ## Development
 
 ```