diff --git a/README.md b/README.md new file mode 100644 index 0000000..158d483 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ + +# Fuel Agent Kit + +## Overview +Fuel Agent Kit is an agentic framework designed to enhance the capabilities of the Fuel Network. It provides tools, libraries, and infrastructure to build, deploy, and manage intelligent agents that can interact with the Fuel Network ecosystem. + +## Prerequisites +Before you begin, ensure you have the following installed on your system: + +- **Fuel Toolchain**: The Fuel development environment and toolchain. +- **Node.js**: Version 16 or higher for building and running agent applications. + +## Installation + +1. **Clone the Repository**: + ```bash + git clone https://github.com/priyanshudumps/fuel-agent-kit.git + cd fuel-agent-kit + ``` + +2. **Install Dependencies**: + ```bash + npm install + ``` + +3. **Set Up Environment**: + Configure your environment variables as specified in the `.env.example` file. + +## License +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/python/README.md b/python/README.md new file mode 100644 index 0000000..7b57bf1 --- /dev/null +++ b/python/README.md @@ -0,0 +1,49 @@ + +# Fuel Agent Kit - Python Implementation + +Fuel Agent Kit provides tools for building and managing fuel agents in Python. + +## Prerequisites + +- Python 3.10 or higher +- pip package manager + +## Installation + +Install the Fuel Agent Kit using pip: + +```bash +pip install fuel-agent-kit +``` + +## Quick Start + +Here's how to initialize a basic Fuel Agent: + +```python +from fuel_agent import FuelAgent + +# Initialize a new Fuel Agent +agent = FuelAgent( + agent_id="my_agent_123", + name="My Fuel Agent", + description="A sample fuel agent implementation" +) + +# Start the agent +agent.start() + +# Stop the agent when done +agent.stop() +``` + +## Features + +- Fuel agent management +- Configuration and initialization +- Integration with fuel infrastructure +- Extensible architecture for custom agents + +## Documentation + +For more detailed documentation and API reference, please visit our [official documentation](https://fuel-agent-kit.org/docs). diff --git a/python/examples/README.md b/python/examples/README.md new file mode 100644 index 0000000..9cd5873 --- /dev/null +++ b/python/examples/README.md @@ -0,0 +1,27 @@ + +# Python Examples for Fuel Agent Kit + +This directory contains example Python scripts demonstrating how to use the Fuel Agent Kit. + +## Available Examples + +1. **wallet_setup.py** + Run this script to create and manage a Fuel wallet for testing purposes. Execute with `python wallet_setup.py`. + +2. **asset_transfer.py** + This example demonstrates how to transfer assets between wallets using the Fuel Agent Kit. Run it with `python asset_transfer.py`. + +3. **simple_agent.py** + A basic example of creating and interacting with a simple Fuel agent. Start it with `python simple_agent.py`. + +## Getting Started + +To run any of these examples: +1. Make sure you have Python 3.8+ installed +2. Install the required dependencies: `pip install fuel-py` +3. Navigate to the examples directory: `cd python/examples` +4. Run your desired example script + +## Summary + +Completed Python examples guide for [priyanshudumps/fuel-agent-kit].