# readme-structure

> Structure READMEs with: project title and brief description, badges (build status, version), quic... Use when documenting code and APIs. Documentation category skill.

- Author: OmniaffixDave
- Repository: OmniaffixDave/SessionGuardian
- Version: 20260205125233
- Stars: 0
- Forks: 1
- Last Updated: 2026-02-08
- Source: https://github.com/OmniaffixDave/SessionGuardian
- Web: https://mule.run/skillshub/@@OmniaffixDave/SessionGuardian~readme-structure:20260205125233

---

---
name: readme-structure
description: "Structure READMEs with: project title and brief description, badges (build status, version), quic... Use when documenting code and APIs. Documentation category skill."
metadata:
  category: Documentation
  priority: medium
  is-built-in: true
  session-guardian-id: builtin_readme_structure
---

# README Structure

Structure READMEs with: project title and brief description, badges (build status, version), quick start instructions, installation steps, basic usage examples, configuration options, API reference (or link to it), contributing guidelines, and license. Lead with the most important information. Keep it updated. A good README answers: What is this? How do I use it? Where do I get help?