Skip to content

Add comprehensive README documentation - #42

Open
jbfromsd wants to merge 1 commit into
priyanshudumps:mainfrom
jbfromsd:add-readme
Open

Add comprehensive README documentation#42
jbfromsd wants to merge 1 commit into
priyanshudumps:mainfrom
jbfromsd:add-readme

Conversation

@jbfromsd

Copy link
Copy Markdown

Resolves #3 — Adds a comprehensive README to the repository.

What's included

  • Project description — Clear explanation of what fuel-agent-kit does
  • Features list — All capabilities at a glance
  • Installation instructions — npm install with peer dependency note
  • Quick Start — Minimal example to get running
  • Configuration reference — TypeScript interface with all options documented
  • Supported Models — Table of OpenAI, Anthropic, and Gemini models
  • Programmatic Usage — Direct function call examples for all operations (swap, transfer, supply, borrow, liquidity, balance)
  • AI Agent Tools — Table of all tools available via natural language
  • Environment Variables — Copy-paste ready env setup
  • Development — Build, test, format, and lint commands

All documentation is derived directly from the source code (FuelAgent.ts, tools.ts, agent.ts, package.json).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

missing readme

1 participant