Introduction

In the plugin ecosystem of DeepSeek Harness (DSH), writing README documentation for GitHub projects is a common workflow task. Traditional approaches usually only focus on generating text, while supporting images often need to be handled manually. This section introduces dsh-readme-writer, an Agent Skill for DSH that writes or optimizes the README.md for GitHub projects and addresses the image requirement.

Plugin Overview

This is a workflow plugin maintained by wenbuer. Its core purpose is to automatically generate or improve the main page description of a GitHub project while handling image details.

Core Features

The plugin is built on the Cordis skill-bundle architecture and provides the following capabilities:

  1. Automatic type detection and screenshots: Depending on the target project type (web or CLI), it automatically selects the screenshot method. Web projects generate web screenshots, while CLI projects generate terminal screenshots.
  2. Image path management: Screenshots are stored uniformly in the project’s images/ folder and referenced using relative paths, ensuring that images are not lost.
  3. Image captions: Each image is automatically accompanied by explanatory text below it, describing the image content.
  4. Text-only fallback: If screenshots cannot be generated, the plugin automatically switches to a text-and-table mode to ensure the README remains complete.

Installation and Activation

Use the following command to install it:

dsh plugin --profile <profile> add wenbuer/dsh-readme-writer

After installation, the plugin is loaded as a Cordis skill-bundle and registers the readme-writer skill at the host layer.

Usage

After installation and activation, enter the following instruction directly in a DSH session:

“Write the README for this project”

The skill will automatically detect screenshot capabilities and ask whether images are needed. It will then generate the corresponding README content based on the project type.

Notes

  1. Image generation: The plugin itself does not bundle example README screenshots. Supporting images are generated by the skill at runtime for the specific target project as needed.
  2. Image storage: Generated images are stored uniformly in the images/ directory.
  3. License: The plugin is distributed under the MIT License.

Ecosystem Links

To learn more or view the source code, visit:
* DSH Plugin Directory
* GitHub Repository