Skip to content

Commit

Permalink
docs: update icon and banner size requirements in README.md
Browse files Browse the repository at this point in the history
- Icon: Must be 1:1 ratio, at least 80x80px
- Banner: Must be 16:9 ratio, at least 1200x676px

Co-Authored-By: Nicolas Arqueros <nico@dcspark.io>
  • Loading branch information
devin-ai-integration[bot] and nicarq committed Jan 28, 2025
1 parent db983a0 commit f68cf6d
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A collection of official tools for Shinkai, providing various functionalities fr

## Overview

This repository hosts a suite of tools designed to work with Shinkai's infrastructure
This repository hosts a suite of tools designed to work with Shinkai's infrastructure. Each tool is built to provide specific functionality while maintaining security and reliability through Shinkai's sandboxed environment.

## Available Tools

Expand All @@ -26,6 +26,60 @@ Currently available tools include:

And more!

## Tool Spotlight: DuckDuckGo Search

The DuckDuckGo Search tool demonstrates the capabilities and structure of a Shinkai tool:

### Functionality
- Performs web searches using DuckDuckGo
- Supports both API-based and browser-based search methods
- Returns structured results with titles, descriptions, and URLs

### Implementation
- Primary search using DuckDuckGo's API
- Fallback to Puppeteer-based web scraping
- Configurable Chrome path for browser automation

### Required Configuration
```json
{
"chromePath": "Optional path to Chrome executable"
}
```

### Input Parameters
```json
{
"message": "Your search query string"
}
```

### Output Format
```json
{
"message": "[{\"title\": \"Result Title\", \"description\": \"Result Description\", \"url\": \"https://result.url\"}]",
"puppeteer": false
}
```

## Tool Development Requirements

### Required Files
1. `metadata.json`: Tool configuration and interface definition
2. `tool.ts` or `tool.py`: Implementation code
3. `README.md`: Documentation and usage instructions

### Required Assets
1. Icon Image
- Dimensions: Must be 1:1 ratio, at least 80x80 pixels
- Format: PNG
- Purpose: Tool identification in UI

2. Banner Image
- Dimensions: Must be 16:9 ratio, at least 1200x676 pixels
- Format: PNG
- Purpose: Visual representation in store

## Project Structure
```
tools/
Expand Down

0 comments on commit f68cf6d

Please sign in to comment.