adambien/readme
documentation/readme/SKILL.md
Write and refine README.md files for software projects targeting advanced developers. Use when asked to create, write, generate, update, refine, or review a README or README.md file. Triggers on "create a README", "write README", "update README", "review README", "generate README.md", or when a README.md is being created or edited as part of a project. Not for API documentation, changelogs, or non-README markdown files.
$ install --global
skillsauthnpx skillsauth add adambien/airails readmeInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Mar 30, 2026, 11:10 AM56.9s1 file scanned
SKILL.md
- name:
- readme
- description:
- >
README Writing
Style
- Target audience: advanced developers. Assume familiarity with tools, frameworks, and patterns.
- Use precise, concise language. Every sentence must convey information.
- Use imperative form for instructions (e.g., "Run the build" not "You can run the build").
- Avoid generic adjectives: "simple", "lightweight", "powerful", "easy-to-use", "robust".
- Avoid the term "Orchestrates" — use more specific alternatives (e.g., "coordinates", "delegates to", "calls").
Structure
- Keep READMEs brief and to the point — favor clarity over completeness.
- Do NOT include detailed project structure (file/folder tree listings). High-level module descriptions are acceptable.
- Do NOT list REST resources or API endpoints in READMEs.
- If modules are listed, provide links to their directories or documentation.
- Use Mermaid for diagrams. GitHub renders Mermaid natively in markdown.
Content
- Lead with what the project does in one or two sentences.
- Include only essential sections: purpose, prerequisites, build/run instructions, configuration (if non-obvious).
- Omit sections that add no value (e.g., "Contributing", "License" boilerplate) unless explicitly requested.
Example skeleton
# Project Name
One or two sentences: what it does and why.
## Prerequisites
Java 25+, Docker
## Build and Run
\`\`\`
mvn clean package
java -jar target/app.jar
\`\`\`
## Configuration
Only if non-obvious.
Related Skills
adambien/java-conventions
tools
VerifiedTrustedCommunity
Generic, composable Java 25 code conventions — modern syntax, code style, naming, visibility, structure, methods, streams, exceptions, and documentation rules that apply across all Java contexts (single-file scripts, CLI apps, MicroProfile/Jakarta EE servers, libraries). Technology-neutral within the Java world; meant to be composed with context-specific skills (e.g. `java-cli-script`, `java-cli-app`, `microprofile-server`, `bce`). Use when writing, generating, or reviewing Java code anywhere the composed skill does not already specify style. Triggers on "Java conventions", "Java style", "Java code style", "modern Java", "Java 25", "idiomatic Java", or any request to write or review Java code where context-specific skills do not already cover style.
23SKILL.mdUpdated May 25, 2026
adambien/java-cli-script
tools
VerifiedTrustedCommunity
Create zero-dependency, single-file executable Java scripts for system-wide use via PATH. Use when asked to create a single-file Java shell script, system utility, PATH-installed Java tool, or shebang-launched Java program without the .java extension. Triggers on "Java script", "Java utility", "PATH script", "system script", or requests for single-file Java programs installed in /usr/local/bin or similar PATH directories. Not for multi-file Java applications — use java-cli-app for those.
23SKILL.mdUpdated Mar 27, 2026
adambien/microprofile-server
development
VerifiedTrustedCommunity
Architecture and coding rules for long-running Java MicroProfile / Jakarta EE server applications — BCE layering, business components (BC), JAX-RS resources, CDI, JSON-P, testing (unit/integration/system), and Maven project structure. Use when creating, generating, scaffolding, writing, or reviewing code, resources, entities, boundaries, or business components in MicroProfile server projects. Not for serverless deployments.
23SKILL.mdUpdated Mar 27, 2026
adambien/java-cli-app
tools
VerifiedTrustedCommunity
Create and maintain multi-file Java 25 CLI applications packaged as executable JARs with zb (Zero Dependencies Builder). Use when asked to create a Java CLI application, a CLI project with multiple source files, or an executable JAR. Triggers on "Java CLI app", "CLI application", "multi-file Java", "executable JAR", "zb build", or requests for Java programs that need multiple source files or JAR packaging. Not for single-file scripts — use java-cli-script for those.
23SKILL.mdUpdated Mar 27, 2026