readme-generator

Included with Lifetime

$97 forever

Creates comprehensive README files with templates for different project types. Use when creating README, project documentation, or getting started guides.

General

What this skill does


# README Generator

## Quick Start

Generate a README based on project type:

```bash
# Detect project type
ls package.json && echo "Node.js project" || \
ls setup.py pyproject.toml && echo "Python project" || \
ls go.mod && echo "Go project"
```

## Instructions

### Step 1: Analyze Project

Gather project information:
- Project name (from package.json, pyproject.toml, etc.)
- Description (from manifest or git)
- Main language and framework
- Key features (scan source files)
- Dependencies (from manifest files)

### Step 2: Select Template

Choose template based on project type:

| Type | Template | Key Sections |
|------|----------|--------------|
| Library | library | Installation, API, Examples |
| CLI Tool | cli | Installation, Commands, Options |
| Web App | webapp | Features, Setup, Deployment |
| API | api | Endpoints, Authentication, Examples |

### Step 3: Generate Core Sections

**Title and Description:**
```markdown
# Project Name

Brief one-line description of what the project does.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)
```

**Installation:**
```markdown
## Installation

\`\`\`bash
npm install project-name
# or
pip install project-name
\`\`\`
```

**Usage:**
```markdown
## Usage

\`\`\`javascript
const project = require('project-name');

// Basic example
project.doSomething();
\`\`\`
```

### Step 4: Add Project-Specific Content

Include relevant sections:
- **Features**: Bullet list of key capabilities
- **API Reference**: For libraries
- **Configuration**: For configurable tools
- **Examples**: Real-world use cases
- **Contributing**: How to contribute
- **License**: License information

### Step 5: Add Badges and Links

Common badges:
```markdown
![Build Status](https://github.com/user/repo/workflows/CI/badge.svg)
![Coverage](https://codecov.io/gh/user/repo/branch/main/graph/badge.svg)
![npm version](https://badge.fury.io/js/package-name.svg)
```

## README Structure

### Essential Sections (all projects)

1. **Title and Description**
2. **Installation**
3. **Quick Start / Usage**
4. **License**

### Recommended Sections

5. **Features** - What makes it useful
6. **Documentation** - Link to full docs
7. **Examples** - Common use cases
8. **Contributing** - How to help
9. **Support** - Where to get help

### Optional Sections

10. **Requirements** - System dependencies
11. **Configuration** - Setup options
12. **Troubleshooting** - Common issues
13. **Changelog** - Recent changes
14. **Acknowledgments** - Credits

## Advanced

For detailed information, see:
- [Templates](reference/templates.md) - README templates by project type
- [Best Practices](reference/best-practices.md) - Documentation standards and style guide

Files: 3

Size: 10.2 KB

Complexity: 24/100

Category: General

Source: https://github.com/armanzeroeight/fastagent-plugins/tree/main/plugins/documentation-toolkit/skills/readme-generator

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts