Add project README - #41
Open
yufanwu345-eng wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a repository README to document fuel-agent-kit usage, configuration, and development workflow to address the “missing readme” issue (#3).
Changes:
- Documented installation and environment configuration for OpenAI/Anthropic/Gemini-backed agents.
- Added quick start examples plus a direct (non-natural-language) API usage section.
- Documented basic development commands and safety notes for transaction-signing behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```ts | ||
| const agent = new FuelAgent({ | ||
| walletPrivateKey: process.env.FUEL_WALLET_PRIVATE_KEY!, | ||
| model: 'claude-3-5-sonnet-20241022', |
Comment on lines
+15
to
+17
| - Add liquidity to Mira pools | ||
| - Supply collateral and borrow assets on Swaylend | ||
| - Build standalone transaction flows without using the agent executor |
| - `swapExactInput(params)` swaps an exact input amount on Mira | ||
| - `addLiquidity(params)` adds liquidity to a Mira pool | ||
| - `supplyCollateral(params)` supplies collateral on Swaylend | ||
| - `borrowAsset(params)` borrows from Swaylend |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
Closes #3