Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guillevalin authored Jan 28, 2025
1 parent 43adda3 commit 04f8feb
Showing 1 changed file with 9 additions and 22 deletions.
31 changes: 9 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,15 @@ Every Shinkai tool requires specific files to function properly. Here's a detail
### icon.png
- Square image in PNG format (1:1 ratio)
- Minimum dimensions: 80x80 pixels
- Used for tool identification in the Shinkai UI
- Used for tool identification in the Shinkai UI and Store
- Example: A distinctive icon representing the tool's primary function

### banner.png
- Wide image in PNG format (16:9 ratio)
- Minimum dimensions: 1200x676 pixels
- Used for tool identification in the Shinkai UI and Store
- Example: A real world usage scenario that explains the tool benefits.

### metadata.json
- Defines tool configuration and interface
- Contains version, name, description, and author
Expand Down Expand Up @@ -94,34 +100,15 @@ export default async function(input: string): Promise<string> {
- Examples of input/output formats
- Any additional requirements or dependencies

## 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/
├── tool-example/
│ ├── metadata.json # Tool metadata.
│ ├── README.md # A description of the tool.
│ └── tool.ts # The code of the tool.
├── packages/
│ ├── tool.zip # Zipped contents of the tool.
│ └── directory.json # A listing of the available tools.
│ └── icon.png # Icon of the tool.
│ └── banner.png # Banner of the tool.
```

## Run Tests
Expand Down

0 comments on commit 04f8feb

Please sign in to comment.