Skip to content

Commit 5c9a8d6

Browse files
wtfsayoshakkernerd
andauthored
chore: Update README.md (#2280)
* Update README.md --------- Co-authored-by: Shakker Nerd <165377636+shakkernerd@users.noreply.github.com>
1 parent 94823e1 commit 5c9a8d6

File tree

1 file changed

+41
-26
lines changed

1 file changed

+41
-26
lines changed

README.md

+41-26
Original file line numberDiff line numberDiff line change
@@ -61,33 +61,21 @@ cp .env.example .env
6161
pnpm i && pnpm build && pnpm start
6262
```
6363

64-
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
65-
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
66-
67-
```bash
68-
pnpm start:client
69-
```
70-
71-
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
72-
7364
### Manually Start Eliza (Only recommended if you know what you are doing)
7465

66+
#### Checkout the latest release
67+
7568
```bash
7669
# Clone the repository
7770
git clone https://github.com/elizaos/eliza.git
7871

79-
# Checkout the latest release
8072
# This project iterates fast, so we recommend checking out the latest release
8173
git checkout $(git describe --tags --abbrev=0)
8274
# If the above doesn't checkout the latest release, this should work:
8375
# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
8476
```
8577

86-
### Start Eliza with Gitpod
87-
88-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
89-
90-
### Edit the .env file
78+
#### Edit the .env file
9179

9280
Copy .env.example to .env and fill in the appropriate values.
9381

@@ -97,6 +85,32 @@ cp .env.example .env
9785

9886
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
9987

88+
89+
#### Start Eliza
90+
91+
```bash
92+
pnpm i
93+
pnpm build
94+
pnpm start
95+
96+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
97+
pnpm clean
98+
```
99+
100+
### Interact via Browser
101+
102+
```
103+
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
104+
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
105+
106+
```bash
107+
pnpm start:client
108+
```
109+
110+
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
111+
112+
----
113+
100114
### Automatically Start Eliza
101115

102116
The start script provides an automated way to set up and run Eliza:
@@ -109,7 +123,9 @@ For detailed instructions on using the start script, including character managem
109123

110124
> **Note**: The start script handles all dependencies, environment setup, and character management automatically.
111125
112-
### Edit the character file
126+
----
127+
128+
### Modify Character
113129

114130
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
115131

@@ -119,16 +135,7 @@ For detailed instructions on using the start script, including character managem
119135
3. Connect with X (Twitter)
120136
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
121137

122-
### Manually Start Eliza
123-
124-
```bash
125-
pnpm i
126-
pnpm build
127-
pnpm start
128-
129-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
130-
pnpm clean
131-
```
138+
---
132139

133140
#### Additional Requirements
134141

@@ -137,6 +144,14 @@ You may need to install Sharp. If you see an error when starting up, try install
137144
```
138145
pnpm install --include=optional sharp
139146
```
147+
---
148+
149+
150+
### Start Eliza with Gitpod
151+
152+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
153+
154+
---
140155

141156
### Community & contact
142157

0 commit comments

Comments
 (0)