From 37e3886bb06fd6ef146036b36eeaf353077187c9 Mon Sep 17 00:00:00 2001 From: Sayo Date: Fri, 24 Jan 2025 23:22:43 +0530 Subject: [PATCH] Update README.md --- README.md | 86 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 61 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 4a7a80e745..a263430233 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,39 @@ -# Eliza 🤖 +
-
- Eliza Banner -
+# 🤖 Eliza -
+![Eliza Banner](./docs/static/img/eliza_banner.jpg) -📑 [Technical Report](https://arxiv.org/pdf/2501.06781) | 📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) +--- + +[![Technical Report](https://img.shields.io/badge/📑_Technical_Report-blue)](https://arxiv.org/pdf/2501.06781) +[![Documentation](https://img.shields.io/badge/📖_Documentation-green)](https://elizaos.github.io/eliza/) +[![Examples](https://img.shields.io/badge/🎯_Examples-orange)](https://github.com/thejoven/awesome-eliza)
+--- + ## 🌍 README Translations -[中文说明](i18n/readme/README_CN.md) | [日本語の説明](i18n/readme/README_JA.md) | [한국어 설명](i18n/readme/README_KOR.md) | [Persian](i18n/readme/README_FA.md) | [Français](i18n/readme/README_FR.md) | [Português](i18n/readme/README_PTBR.md) | [Türkçe](i18n/readme/README_TR.md) | [Русский](i18n/readme/README_RU.md) | [Español](i18n/readme/README_ES.md) | [Italiano](i18n/readme/README_IT.md) | [ไทย](i18n/readme/README_TH.md) | [Deutsch](i18n/readme/README_DE.md) | [Tiếng Việt](i18n/readme/README_VI.md) | [עִברִית](i18n/readme/README_HE.md) | [Tagalog](i18n/readme/README_TG.md) | [Polski](i18n/readme/README_PL.md) | [Arabic](i18n/readme/README_AR.md) | [Hungarian](i18n/readme/README_HU.md) | [Srpski](i18n/readme/README_RS.md) | [Română](i18n/readme/README_RO.md) | [Nederlands](i18n/readme/README_NL.md) | [Ελληνικά](i18n/readme/README_GR.md) +
+ +[中文说明](i18n/readme/README_CN.md) • [日本語の説明](i18n/readme/README_JA.md) • [한국어 설명](i18n/readme/README_KOR.md) • [Persian](i18n/readme/README_FA.md) • [Français](i18n/readme/README_FR.md) • [Português](i18n/readme/README_PTBR.md) • [Türkçe](i18n/readme/README_TR.md) • [Русский](i18n/readme/README_RU.md) • [Español](i18n/readme/README_ES.md) • [Italiano](i18n/readme/README_IT.md) • [ไทย](i18n/readme/README_TH.md) • [Deutsch](i18n/readme/README_DE.md) • [Tiếng Việt](i18n/readme/README_VI.md) • [עִברִית](i18n/readme/README_HE.md) • [Tagalog](i18n/readme/README_TG.md) • [Polski](i18n/readme/README_PL.md) • [Arabic](i18n/readme/README_AR.md) • [Hungarian](i18n/readme/README_HU.md) • [Srpski](i18n/readme/README_RS.md) • [Română](i18n/readme/README_RO.md) • [Nederlands](i18n/readme/README_NL.md) • [Ελληνικά](i18n/readme/README_GR.md) + +
+ +--- ## 🚩 Overview
- Eliza Diagram + +![Eliza Diagram](./docs/static/img/eliza_diagram.png) +
+--- + ## ✨ Features - 🛠️ Full-featured Discord, Twitter and Telegram connectors @@ -30,9 +44,13 @@ - 🚀 Highly extensible - create your own actions and clients - 📦 Just works! -## Video Tutorials +--- + +## 📺 Video Tutorials -[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL) +[![AI Agent Dev School](https://img.shields.io/badge/🎓_AI_Agent_Dev_School-red)](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL) + +--- ## 🎯 Use Cases @@ -42,6 +60,8 @@ - 🎮 Video Game NPCs - 🧠 Trading +--- + ## 🚀 Quick Start ### Prerequisites @@ -65,8 +85,10 @@ cd eliza-starter cp .env.example .env pnpm i && pnpm build && pnpm start ``` + Once the agent is running, You should see the message to run "pnpm start:client" at the end. Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. + ```bash pnpm start:client ``` @@ -91,11 +113,11 @@ git checkout $(git describe --tags --abbrev=0) Copy .env.example to .env and fill in the appropriate values. -``` +```bash cp .env.example .env ``` -Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON +> **Note:** .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON #### Start Eliza @@ -108,6 +130,8 @@ pnpm start pnpm clean ``` +--- + ### Interact via Browser Once the agent is running, you should see the message to run "pnpm start:client" at the end. @@ -140,11 +164,9 @@ For detailed instructions on using the start script, including character managem 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit. 2. To load custom characters: - - Use `pnpm start --characters="path/to/your/character.json"` - Multiple character files can be loaded simultaneously -3. Connect with X (Twitter) - +3. Connect with X (Twitter): - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X --- @@ -153,7 +175,7 @@ For detailed instructions on using the start script, including character managem You may need to install Sharp. If you see an error when starting up, try installing it with the following command: -``` +```bash pnpm install --include=optional sharp ``` @@ -165,14 +187,17 @@ pnpm install --include=optional sharp --- -### Community & contact +## 💬 Community & Contact + +- [GitHub Issues](https://github.com/elizaos/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/elizaos/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. +--- -## Citation +## 📄 Citation We now have a [paper](https://arxiv.org/pdf/2501.06781) you can cite for the Eliza OS: + ```bibtex @article{walters2025eliza, title={Eliza: A Web3 friendly AI Agent Operating System}, @@ -182,13 +207,24 @@ We now have a [paper](https://arxiv.org/pdf/2501.06781) you can cite for the Eli } ``` -## Contributors +--- + +## 👥 Contributors + +
+ +[![Contributors](https://contrib.rocks/image?repo=elizaos/eliza)](https://github.com/elizaos/eliza/graphs/contributors) + +
- - Eliza project contributors - +--- +## ⭐ Star History -## Star History +
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date) + +
+ +