create-readme SKILL.md skillA

create-readme from tuliosousapro/saas-blueprint is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add tuliosousapro/saas-blueprint/create-readme@git:20260415.cf6380c

Pins git:20260415.cf6380c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
tuliosousapro/saas-blueprint
Path
skills/create-readme/SKILL.md
Versions recorded
1
Latest version
git:20260415.cf6380c, committed Apr 15, 2026
Size
3,072 bytes
Repository stars
5
License
MIT

Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans ./ directory files and creates a README.md file for the project. Only used when creating a new repository. or when the README.md file is missing.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

## Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

## Task

Analyze the documentation files in the ./ directory. Follow these steps:

1. Scan all the files in the ./ directory, like:
   - Architecture
   - Code_Exemplars
   - Coding_Standards
   - Project_Folder_Structure
   - Technology_Stack
   - Unit_Tests
   - Workflow_Analysis

2. Create a README.md with the following sections:

## Project Name and Description

- Extract the project name and primary purpose from the documentation
- Include a concise description of what the project does

## Technology Stack

- List the primary technologies, languages, and frameworks used
- Include version information when available
- Source this information primarily from the Technology_Stack file

## Project Architecture

- Provide a high-level overview of the architecture
- Consider including a simple diagram if described in the documentation
- Source from the Architecture file

## Getting Started

- Include installation instructions based on the technology stack
- Add setup and configuration steps
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add tuliosousapro/saas-blueprint/create-readme@sha256:aa06e95a657081c0

The line at the top of this page pins the label git:20260415.cf6380c, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_e3k5cyyyp7spwnvn.svg)](https://markdownregistry.com/a/art_e3k5cyyyp7spwnvn)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Apr 15, 2026.

versioncommittedcommitsizeaudit
git:20260415.cf6380c latest2026-04-15 cf6380c 3,072 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3072 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

tuliosousapro/saas-blueprint · 5 stars · license MIT · pushed 2026-08-31 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_e3k5cyyyp7spwnvn
GET https://markdownregistry.com/api/v1/resolve?ref=tuliosousapro/saas-blueprint/create-readme
GET https://markdownregistry.com/api/v1/blob/aa06e95a657081c0e79bd8b63aebe45687ec31f9d8c85bfa2c484dea57597ec9

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from tuliosousapro/saas-blueprint

AGENTS.md AGENTS.md file
tuliosousapro/saas-blueprint · AGENTS.md
git:20260415.cf6380c · audit A · 5 stars
changelog SKILL.md skill
tuliosousapro/saas-blueprint · skills/changelog/SKILL.md · Generates and maintains changelogs following Keep a Changelog format. Use when updating release notes, finishing tasks…
git:20260520.0aeaf85 · audit A · 5 stars
competitor-analysis SKILL.md skill
tuliosousapro/saas-blueprint · skills/competitor-analysis/SKILL.md · Structured competitor teardown skill. Use when scraping competitor sites, extracting pricing/features/positioning, or…
git:20260520.0aeaf85 · audit A · 5 stars
conventional-commits SKILL.md skill
tuliosousapro/saas-blueprint · skills/conventional-commits/SKILL.md · Enforces Conventional Commits format for git commit messages. Use when formatting commits or validating message…
git:20260520.0aeaf85 · audit A · 5 stars
create-llms SKILL.md skill
tuliosousapro/saas-blueprint · skills/create-llms/SKILL.md · Creates an llms.txt file from scratch based on repository structure. Use when configuring LLM discovery files. For…
git:20260520.0aeaf85 · audit A · 5 stars
git-control SKILL.md skill
tuliosousapro/saas-blueprint · skills/git-control/SKILL.md · Standardizes git operations, branch management, and disaster recovery. Use when committing, branching, or resolving…
git:20260520.0aeaf85 · audit A · 5 stars
idea-validator SKILL.md skill
tuliosousapro/saas-blueprint · skills/idea-validator/SKILL.md · Structured validation framework that scores product ideas. Use when evaluating problem severity, willingness-to-pay, or…
git:20260520.0aeaf85 · audit A · 5 stars
market-research SKILL.md skill
tuliosousapro/saas-blueprint · skills/market-research/SKILL.md · Deep web research skill using Firecrawl MCP. Use when estimating market size (TAM/SAM/SOM), analyzing trends, or…
git:20260520.0aeaf85 · audit A · 5 stars
mcp-documentation SKILL.md skill
tuliosousapro/saas-blueprint · skills/mcp-documentation/SKILL.md · Reference and learning guide for the Model Context Protocol (MCP). Use when implementing clients/servers or debugging…
git:20260520.0aeaf85 · audit A · 5 stars
mcp-reference-servers SKILL.md skill
tuliosousapro/saas-blueprint · skills/mcp-reference-servers/SKILL.md · Guidance on using and integrating official reference servers. Use when building custom servers or deploying standard…
git:20260520.0aeaf85 · audit A · 5 stars
mcp-server-registry SKILL.md skill
tuliosousapro/saas-blueprint · skills/mcp-server-registry/SKILL.md · Instructions for discovery and usage of servers through the official MCP registry. Use when discovering new…
git:20260520.0aeaf85 · audit A · 5 stars
playbook-writer SKILL.md skill
tuliosousapro/saas-blueprint · skills/playbook-writer/SKILL.md · Meta-skill that generates compliant PLAYBOOK.md files following the BRAINIAC template. Use when creating or editing…
git:20260520.0aeaf85 · audit A · 5 stars

Every file in tuliosousapro/saas-blueprint

Other files named create-readme

create-readme SKILL.md skill
github/awesome-copilot · skills/create-readme/SKILL.md · Create a README.md file for the project
git:20260224.caab1f6 · audit A · 40,629 stars
create-readme SKILL.md skill
afonsoft/skills · skills/create-readme/SKILL.md · Use when generating or updating a project README.md or CHANGELOG.md.
v1.2.1 · audit A · 14 stars
create-readme SKILL.md skill
tomzx/agents · skills/create-readme/SKILL.md · Generate a README.md for a project using a structured template with badges, feature lists, roadmap, and setup…
git:20261007.b35fc4b · audit A · 14 stars
create-readme SKILL.md skill
j0ruge/skills · .claude/skills/create-readme/SKILL.md · Create a README.md file for the project
git:20260406.449aa01 · audit A · 13 stars
create-readme SKILL.md skill
j0ruge/skills · .agents/skills/create-readme/SKILL.md · Create a README.md file for the project
git:20260406.449aa01 · audit A · 13 stars
create-readme SKILL.md skill
atman-33/workhub · plugins/authoring/skills/create-readme/SKILL.md · Create a comprehensive, well-structured README.md for the current project. Use when the user wants to create, write, or…
git:20260901.114c610 · audit A · 3 stars
create-readme SKILL.md skill
okhp3/skillz · community/create-readme/SKILL.md · Create a README.md file for the project
git:20260828.866dec6 · audit A · 3 stars

Browse by kind, by grade A, or by owner.