docs

README.md

@@ -2,6 +2,14 @@
 
 This is the official Echo Agent Registry for the Echos ecosystem.
 
+## Accessing Echo Agents
+
+To access the Echo Agents, you can use the following URL:
+
+```
+https://registry.echos.fun/api/echos
+```
+
 ## Register an Echo Agent
 
 To register an Echo Agent, you need to create a new unique directory under `src` and add a new `echo.json` file. Feel free to use any of the existing `echo.json` files as a template.
@@ -16,10 +24,27 @@ We have a GitHub workflow that automatically regenerates the entry file and publ
 
 As long as this workflow is committed, Vercel will automatically update our serverless function to include the new Echo Agent.
 
-## Accessing Echo Agents
+## Maintenance
 
-To access the Echo Agents, you can use the following URL:
+If you're not a maintainer, this section is not relevant to you.
+
+This project requires node `v20` and `pnpm`. To install dependencies, run:
 
 ```
-https://registry.echos.fun/api/echos
+pnpm install
+```
+
+You can run the following commands to validate, format, and typecheck, and codegen the project:
+
+```
+pnpm build:validate
+pnpm build:prettier
+pnpm build:typecheck
+pnpm build:codegen
+```
+
+To run the serverless function locally, run:
+
+```
+pnpm start
 ```