readme

Included with Lifetime

$97 forever

Generate StyleList94-style README.md based on project type

General

What this skill does


Generate clean, practical README.md files tailored to project type.

## Project Type Detection

Detect project type by analyzing:

| Type | Detection Criteria |
| ---- | ------------------ |
| Library/Package | `package.json` has `main`, `exports`, or `types` field |
| CLI Tool | `package.json` has `bin` field |
| Plugin Marketplace | `.claude-plugin/marketplace.json` exists |
| Personal Project | None of the above |

> Note: Profile README repositories (username/username) are special-purpose and excluded.

## Section Structure by Type

### Library/Package

```markdown
# Project Name

One-line description

## Getting Started

### Installation

pnpm add package-name

# or npm
npm install package-name

# or yarn
yarn add package-name

### Usage

Basic usage code block

## Features

- Core feature list

## API Reference (optional)

Key API documentation
```

### CLI Tool

```markdown
# Project Name

One-line description

## Getting Started

### Installation

pnpm add -g package-name

## Options

CLI options table or list

## Example

Usage examples
```

### Plugin Marketplace

```markdown
# Project Name

One-line description

## Installation

How to register with marketplace

## Available Plugins

Plugin list

## Project Structure

Directory structure explanation
```

### Personal Project

```markdown
# Project Name

Project description

## Getting Started

Simple run commands
```

## Style Guidelines

### Package Manager

- **pnpm first** as primary
- Provide npm/yarn alternatives:

```bash
pnpm add package-name

# or npm
npm install package-name

# or yarn
yarn add package-name
```

### Code Blocks

- Always specify language: `bash`, `typescript`, `tsx`, etc.
- One command per block for easy copying

### Formatting

- Single blank line between sections
- No unnecessary badges or decorations
- Practical, no-frills style

## Behavior

1. **New README**: Detect project type → Generate appropriate section structure
2. **Update README**: Preserve existing style while adding missing sections

Files: 1

Size: 2.1 KB

Complexity: 9/100

Category: General

Source: https://github.com/stylelist94/claude-plugins/tree/main/plugins/stylish-docs/skills/readme

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