Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhaiwat10 authored Dec 23, 2024
1 parent eea2113 commit ce461d2
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,32 @@ Docs: https://dhaiwatpandya.gitbook.io/fuel-agent-kit/

## Getting Started

```bash
npm install fuel-agent-kit
```

Make sure you have the following environment variables set:

- `OPENAI_API_KEY`: Your OpenAI API key
- `FUEL_WALLET_PRIVATE_KEY`: Your Fuel wallet private key

```ts
import { FuelAgent } from 'fuel-agent-kit';

const agent = new FuelAgent();

// Execute commands in natural language
await agent.execute(
'Send 0.1 USDC to 0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1',
);

// Or, call functions directly
// Call different functions
await agent.transfer({
to: '0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1',
amount: 0.1,
symbol: 'USDC',
});

// or, execute commands in natural language
await agent.execute(
'Send 0.1 USDC to 0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1',
);

// Swap Assets
await agent.execute('Swap 5 USDC for ETH');

Expand Down Expand Up @@ -49,7 +58,7 @@ Make sure you have the following environment variables set:
- `OPENAI_API_KEY`: Your OpenAI API key
- `FUEL_WALLET_PRIVATE_KEY`: Your Fuel wallet private key

To run the agent locally, run the following command:
To run the project locally, run the following command:

Then, install the dependencies:

Expand Down

0 comments on commit ce461d2

Please sign in to comment.