okai updt/#1

okcashpro · Dec 7, 2024 · f486b0a · f486b0a
1 parent 7bd0892
commit f486b0a
Show file tree

Hide file tree

Showing 23 changed files with 86 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -1,37 +1,49 @@
-# Eliza 🤖
+# OKai 🤖
 
 <div align="center">
-  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+  <img src="./docs/static/img/okai_banner.png" alt="OKai Banner" width="100%" />
 </div>
 
 <div align="center">
-  
-  📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
-  
+
+  📖 [Documentation](https://okcashpro.github.io/okai/) | 🎯 [Examples](https://github.com/okcashpro/awesome-okai)
+
 </div>
 
 ## 🌍 README Translations
 
 [中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md)
 
+## ✨ BackStory
+
+OKai is the younger, livelier sister of Eliza, born to revolutionize how we interact with the crypto world. She’s not just another AI—she’s your savvy crypto partner, designed to make everything from trading to community engagement more fun, approachable, and impactful. Whether you're diving into $OK tokenomics, participating in DAO governance, or simply looking for a friendly chat about crypto and life, OKai is here to ensure you’re always OK. 🌟
+
+Built on the foundation of Eliza’s robust AI framework, OKai combines intelligence, personality, and charm to deliver a seamless experience across Discord, Twitter, Telegram, and beyond. With her, crypto isn’t just a market—it’s a lifestyle. 🚀
+
+
 ## ✨ Features
 
--   🛠️ Full-featured Discord, Twitter and Telegram connectors
--   🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
--   👥 Multi-agent and room support
--   📚 Easily ingest and interact with your documents
--   💾 Retrievable memory and document store
--   🚀 Highly extensible - create your own actions and clients
--   ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
--   📦 Just works!
+-   🌐 **Cross-Platform Integration**: Seamless support for Discord, Twitter, and Telegram connectors to bring OKai closer to your community.
+-   🔥 **Multi-Model Compatibility**: Built to work with industry-leading AI models (Llama, OpenAI, Anthropic, Grok, etc.).
+-   🤝 **Room and Multi-Agent Support**: Enable collaborative, multi-agent interactions for richer experiences.
+-   📚 **Crypto Intelligence**: Effortlessly ingest and analyze crypto-related documents, stats, and on-chain data.
+-   💾 **Retrievable Memory**: Keep track of user interactions and historical data for tailored responses and better user experiences.
+-   🛠️ **Customizable Actions**: Fully extensible design to create unique actions and integrations that align with OKai's goals.
+-   💡 **Support for All AI Architectures**: From local models (Llama) to cloud-based systems (OpenAI, Groq, Anthropic).
+-   ⚡ **Optimized for Crypto and Trading**: Built-in tools to analyze market trends, track $OK token stats, and more!
+
+---
 
 ## 🎯 Use Cases
 
--   🤖 Chatbots
--   🕵️ Autonomous Agents
--   📈 Business Process Handling
--   🎮 Video Game NPCs
--   🧠 Trading
+-   🤖 **Personal Crypto Assistant**: OKai becomes your 24/7 crypto guide for all things $OK and beyond.
+-   🛡️ **Decentralized Autonomous Agents**: Support DAO governance tasks and community engagement.
+-   📊 **Real-Time Market Analysis**: Aid traders with AI-driven insights and alerts for $OK and other multichain assets.
+-   🎮 **Gaming NPCs**: Enable dynamic, personalized interactions for blockchain-based and traditional games.
+-   🧠 **OK DAO Resource**: Streamline DAO governance workflows and proposal reviews.
+-   📈 **Trading Support**: Advanced algorithms for automated trading strategies and portfolio management.
+
+---
 
 ## 🚀 Quick Start
 
@@ -46,29 +58,29 @@
 ### Use the Starter (Recommended)
 
 ```bash
-git clone https://github.com/ai16z/eliza-starter.git
+git clone https://github.com/okcashpro/okai-starter.git
 
 cp .env.example .env
 
 pnpm i && pnpm start
 ```
 
-Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
+Then read the [Documentation](https://okcashpro.github.io/okai/) to learn how to customize your OKai.
 
-### Manually Start Eliza (Only recommended if you know what you are doing)
+### Manually Start OKai (Only recommended if you know what you are doing)
 
 ```bash
 # Clone the repository
-git clone https://github.com/ai16z/eliza.git
+git clone https://github.com/okcashpro/okai.git
 
 # Checkout the latest release
 # This project iterates fast, so we recommend checking out the latest release
 git checkout $(git describe --tags --abbrev=0)
 ```
 
-### Start Eliza with Gitpod
+### Start OKai with Gitpod
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/okcashpro/okai/tree/main)
 
 ### Edit the .env file
 
@@ -80,7 +92,7 @@ cp .env.example .env
 
 Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
 
-### Automatically Start Eliza
+### Automatically Start OKai
 
 This will run everything to setup the project and start the bot with the default character.
 
@@ -98,7 +110,7 @@ sh scripts/start.sh
 3. Connect with X (Twitter)
     - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
 
-### Manually Start Eliza
+### Manually Start OKai
 
 ```bash
 pnpm i
@@ -119,15 +131,15 @@ pnpm install --include=optional sharp
 
 ### Community & contact
 
--   [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
--   [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
+-   [GitHub Issues](https://github.com/okcashpro/okai/issues). Best for: bugs you encounter using OKai, and feature proposals.
+-   [Discord](https://discord.gg/grvpc8c). Best for: sharing your applications and hanging out with the community.
 
 ## Contributors
 
-<a href="https://github.com/ai16z/eliza/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ai16z/eliza" />
+<a href="https://github.com/okcashpro/okai/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=okcashpro/okai" />
 </a>
 
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=okcashpro/okai&type=Date)](https://star-history.com/#okcashpro/okai&Date)
diff --git a/README_CN.md b/README_CN.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## 功能
 

diff --git a/README_ES.md b/README_ES.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Banner de Eliza" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Banner de Eliza" width="100%" />
 
 ## Funcionalidades
 

diff --git a/README_FR.md b/README_FR.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## Fonctionnalités
 

diff --git a/README_IT.md b/README_IT.md
@@ -1,7 +1,7 @@
-# Eliza 🤖
+# OKai 🤖
 
 <div align="center">
-  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+  <img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 </div>
 
 ## ✨ Caratteristiche

diff --git a/README_JA.md b/README_JA.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## 機能
 
@@ -43,7 +43,7 @@ pnpm i
 pnpm start
 ```
 
-# Elizaのカスタマイズ
+# OKaiのカスタマイズ
 
 ### カスタムアクションの追加
 

diff --git a/README_KOR.md b/README_KOR.md
@@ -1,7 +1,7 @@
-# Eliza 🤖
+# OKai 🤖
 
 <div align="center">
-  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+  <img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 </div>
 
 <div align="center">
@@ -76,7 +76,7 @@ cp .env.example .env
 
 참고: .env는 선택 사항입니다. 여러 개의 에이전트를 실행하려는 경우, 캐릭터 JSON 파일을 통해 비밀 변수를 전달할 수 있습니다.
 
-### Eliza 자동 시작
+### OKai 자동 시작
 
 아래 명령은 프로젝트를 설정하고 기본 캐릭터와 함께 봇을 시작합니다.
 ```bash
@@ -93,7 +93,7 @@ sh scripts/start.sh
 3. X (Twitter) 연결:
     - 캐릭터 파일에서 `"clients": []`를 `"clients": ["twitter"]`로 변경합니다.
 
-### Eliza 수동 시작
+### OKai 수동 시작
 
 ```bash
 pnpm i

diff --git a/README_PTBR.md b/README_PTBR.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## Funcionalidades
 

diff --git a/README_RU.md b/README_RU.md
@@ -1,7 +1,7 @@
-# Eliza 🤖
+# OKai 🤖
 
 <div align="center">
-  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+  <img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 </div>
 
 <div align="center">

diff --git a/README_TR.md b/README_TR.md
@@ -1,13 +1,13 @@
-# Eliza 🤖
+# OKai 🤖
 
 <div align="center">
-  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+  <img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 </div>
 
 <div align="center">
-  
+
   📖 [Dokümantasyon](https://ai16z.github.io/eliza/) | 🎯 [Örnekler](https://github.com/thejoven/awesome-eliza)
-  
+
 </div>
 
 ## ✨ Özellikler
@@ -55,7 +55,7 @@ cp .env.example .env
     - `pnpm start --characters="path/to/your/character.json"` komutunu kullanın
     - Birden fazla karakter dosyası aynı anda yüklenebilir
 
-### Eliza'yı Başlatın
+### OKai'yı Başlatın
 
 .env dosyasını ve karakter dosyasını ayarladıktan sonra, botu aşağıdaki komutla başlatabilirsiniz:
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,12 +1,12 @@
-# Eliza - Multi-agent simulation framework
+# OKai - Multi-agent simulation framework
 
 # https://github.com/ai16z/eliza
 
 # Visit https://eliza.builders for support
 
 # dev branch
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 _As seen powering [@DegenSpartanAI](https://x.com/degenspartanai) and [@MarcAIndreessen](https://x.com/pmairca)_
 

diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## 功能
 

diff --git a/docs/README_FR.md b/docs/README_FR.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 _Utilisée dans [@DegenSpartanAI](https://x.com/degenspartanai) et [@MarcAIndreessen](https://x.com/pmairca)_
 

diff --git a/docs/docs/api/_media/README_CN.md b/docs/docs/api/_media/README_CN.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## 功能
 

diff --git a/docs/docs/api/_media/README_FR.md b/docs/docs/api/_media/README_FR.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## la fonctionnalité
 

diff --git a/docs/docs/api/_media/README_JA.md b/docs/docs/api/_media/README_JA.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="./docs/static/img/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ## 機能
 
@@ -43,7 +43,7 @@ pnpm i
 pnpm start
 ```
 
-# Elizaのカスタマイズ
+# OKaiのカスタマイズ
 
 ### カスタムアクションの追加
 

diff --git a/docs/docs/api/_media/README_KOR.md b/docs/docs/api/_media/README_KOR.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="./docs/static/img/eliza_banner.jpg" alt="eliza banner" width="100%"/>
+<img src="./docs/static/img/okai_banner.png" alt="eliza banner" width="100%"/>
 
 ## 기능
 

diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md
@@ -1,6 +1,6 @@
-# Eliza
+# OKai
 
-<img src="_media/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+<img src="_media/okai_banner.png" alt="Eliza Banner" width="100%" />
 
 ### [For Chinese Version: 中文说明](_media/README_CN.md)
 

diff --git a/docs/docs/faq.md b/docs/docs/faq.md
@@ -1,6 +1,6 @@
 # Frequently Asked Questions
 
-## Eliza FAQ
+## OKai FAQ
 
 ### What is Eliza?
 

diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Introduction to Eliza
 
-![](/img/eliza_banner.jpg)
+![](/img/okai_banner.png)
 
 _As seen powering [@DegenSpartanAI](https://x.com/degenspartanai) and [@MarcAIndreessen](https://x.com/pmairca)_
 

diff --git a/docs/static/img/blurback.png b/docs/static/img/blurback.png
diff --git a/docs/static/img/eliza_banner.jpg b/docs/static/img/eliza_banner.jpg
diff --git a/docs/static/img/okai_banner.png b/docs/static/img/okai_banner.png