Skip to content

docs: add TakoAPI directory badge#379

Open
oratis wants to merge 1 commit into
UfoMiao:mainfrom
oratis:add-takoapi-badge
Open

docs: add TakoAPI directory badge#379
oratis wants to merge 1 commit into
UfoMiao:mainfrom
oratis:add-takoapi-badge

Conversation

@oratis

@oratis oratis commented Jul 1, 2026

Copy link
Copy Markdown

Hi! 👋 zcf is listed in the TakoAPI open agent directory — a free, open catalog that helps people discover AI-agent projects ("one API to discover all agents").

Your listing: https://takoapi.com/agents/ufomiao-zcf

This PR adds a small badge near the top of the README that links back to that listing, so visitors can find the directory entry. It's entirely optional — if you'd prefer not to include it, just close this PR (no hard feelings, and apologies for the noise).

No tracking and no obligations. Thanks for building zcf! 🙏

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

docs: add TakoAPI directory badge to README

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Add a TakoAPI directory badge to the top of the README.
• Link the badge to the project’s TakoAPI listing for discoverability.
High-Level Assessment

The following are alternative approaches to this PR:

1. Use a text link instead of a badge
  • ➕ Less visual noise at the top of the README
  • ➕ No external badge image request
  • ➖ Lower visibility/CTR than a badge
  • ➖ Less consistent with other README badges
2. Use a Shields.io-style badge
  • ➕ Consistent styling with common README badges
  • ➕ Potentially better caching/CDN behavior
  • ➖ Introduces another third-party dependency if TakoAPI already provides the official badge
  • ➖ May not reflect TakoAPI’s preferred branding

Recommendation: The current approach is appropriate for a lightweight discoverability link: a single official TakoAPI badge near the top of the README. If the project prefers fewer badges or fewer external image loads, consider switching to a plain text link instead.

Files changed (1) +2 / -0

Documentation (1) +2 / -0
README.mdAdd TakoAPI listing badge +2/-0

Add TakoAPI listing badge

• Adds a new TakoAPI badge at the top of the README. The badge links to the project’s TakoAPI directory entry.

README.md

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Informational

1. Third-party badge fetch 🐞 Bug ⛨ Security
Description
The new README badge embeds an image hosted on takoapi.com, so anyone viewing the README will fetch
that image from a third-party domain and expose basic request metadata (e.g., IP address and
User-Agent) to that host. If the project prefers to avoid additional third-party requests from
documentation, the badge image should be self-hosted (while keeping the link to TakoAPI if desired).
Code

README.md[1]

+[![Listed on TakoAPI](https://takoapi.com/api/badge/ufomiao-zcf)](https://takoapi.com/agents/ufomiao-zcf)
Evidence
The added markdown uses an absolute https://takoapi.com/api/badge/... image URL, which requires
fetching the image from that third-party host when rendered.

README.md[1-4]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The README adds a badge image loaded from `https://takoapi.com/...`, which causes README renderers to make a third-party network request.

## Issue Context
This is documentation-only, but projects that are privacy-conscious or want to minimize third-party dependencies in docs typically avoid externally hosted badge images.

## Fix Focus Areas
- README.md[1-2]

## Suggested fix
- Download the badge image and commit it into the repo (e.g., `src/assets/takoapi-badge.svg`), then update the markdown to use the local image while keeping the hyperlink to the TakoAPI listing.
 - Example:
   - ` [![Listed on TakoAPI](./src/assets/takoapi-badge.svg)](https://takoapi.com/agents/ufomiao-zcf)`
- Alternatively, remove the badge image and keep a plain text link if you want zero third-party image fetches.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment thread README.md
@@ -1,3 +1,5 @@
[![Listed on TakoAPI](https://takoapi.com/api/badge/ufomiao-zcf)](https://takoapi.com/agents/ufomiao-zcf)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Informational

1. Third-party badge fetch 🐞 Bug ⛨ Security

The new README badge embeds an image hosted on takoapi.com, so anyone viewing the README will fetch
that image from a third-party domain and expose basic request metadata (e.g., IP address and
User-Agent) to that host. If the project prefers to avoid additional third-party requests from
documentation, the badge image should be self-hosted (while keeping the link to TakoAPI if desired).
Agent Prompt
## Issue description
The README adds a badge image loaded from `https://takoapi.com/...`, which causes README renderers to make a third-party network request.

## Issue Context
This is documentation-only, but projects that are privacy-conscious or want to minimize third-party dependencies in docs typically avoid externally hosted badge images.

## Fix Focus Areas
- README.md[1-2]

## Suggested fix
- Download the badge image and commit it into the repo (e.g., `src/assets/takoapi-badge.svg`), then update the markdown to use the local image while keeping the hyperlink to the TakoAPI listing.
  - Example:
    - ` [![Listed on TakoAPI](./src/assets/takoapi-badge.svg)](https://takoapi.com/agents/ufomiao-zcf)`
- Alternatively, remove the badge image and keep a plain text link if you want zero third-party image fetches.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant