Skip to content

Latest commit

 

History

History

README.md

How to Add Your Agent

When contributing a new agent example, please update the table in the default Readme with your agent's details:

  • Agent Name: The name/title of your agent example
  • Use Case: Brief description of what the agent does
  • Learn: Key concepts demonstrated (e.g., State management, Tool integration)
  • Tag: Category tags (e.g., chat, automation, analysis)
  • Interaction Type: Workflow or Conversational
  • Complexity: Beginner, Intermediate, or Advanced
  • Agent Type: Single-agent, Multi-agent, Tool-based, etc.
  • Vertical: Industry/domain focus (General, Healthcare, Finance, etc.)

Things to Include in Your Project

When creating your agent project, ensure it includes the following:

  • README.md: A detailed README file with setup, usage, and contribution instructions
  • env.example: Example environment variable file for configuration
  • Source Code: Well-structured and commented code demonstrating ADK-TS usage

Things to Include in Your Readme

  • Overview of the project and its purpose
  • Key features and functionalities
  • Architecture, workflow diagrams, and project structure
  • Setup instructions and prerequisites
  • Usage examples and sample interactions
  • Links to documentation and community resources
  • Ways to contribute and get involved
  • License information
  • CTA to encourage users to build their own agents