ShalomDeitch1

README.md files

@ShalomDeitch1/README.md files
ShalomDeitch1
0
0 forks
Updated 1/6/2026
View on GitHub

README.md writer: use this skill to write README.md files

Installation

$skills install @ShalomDeitch1/README.md files
Claude Code
Cursor
Copilot
Codex
Antigravity

Details

Path.github/skills/README.md files/SKILL.md
Branchmain
Scoped Name@ShalomDeitch1/README.md files

Usage

After installing, this skill will be available to your AI coding assistant.

Verify installation:

skills list

Skill Instructions


name: README.md writer description: use this skill to write README.md files

instructions

  • README.md files should describe the contents of the project they are in.
  • if there are sub-projects they should have links to those projects
  • they should be concise and clear
  • where possible they should contain mermaid graphs that show the flow
  • where possible they should contain mermaid sequences that show the sequence
  • everything should be as simple as possible

example

see ticketmaster\tech-waiting-room-buffer\kafka\README.md see localDelivery\optimizedLocalDeliveryService\README.md

audience

  • people who want to understand more about system's design and how to implement using those concepts