readme-creator
README Creator
Create clear, professional README.md files grounded in the actual project.
Required Sections (always include)
- Title + Description — Project name as
# Title, followed by 1–3 sentences: what it does and its purpose. No badges unless provided. - Features — Bulleted list of key capabilities. Be specific; don't invent features.
- Installation — Exact commands to install the project and its dependencies.
- Usage — Minimal working example(s) with code blocks. Show the most common use case first.
- Contributing — Brief guide: fork → branch → PR. One short paragraph or 3–4 bullets.
- License — State the license. Default to MIT if unspecified:
Distributed under the MIT License.
Conditional Sections (include only when justified)
- Prerequisites — Only if the project requires specific runtimes, accounts, environment variables, or non-obvious tools. Skip if setup is standard (e.g., just
npm install).
Optional Sections (include when they add clear value)
More from aksuharun/skills
lucide-icons
Use Lucide icons correctly across any framework or environment. Lucide is a tree-shakeable SVG icon library with 1000+ icons. Use this skill when working with Lucide icons in React, Vue, Svelte, Solid, Preact, Angular, Astro, React Native, Vanilla JS, or static/server-side environments. Triggers include installing lucide icons, importing lucide components, customizing icon appearance, using dynamic icons, or using Lucide lab custom icons.
101git-best-practices
Git best practices for commit messages and branch workflow. Use when writing or reviewing commit messages, advising on branching, merging, rebasing, PRs, or keeping a clean linear history.
12reka-ui
Use when building accessible Vue.js interfaces with Reka UI (Radix Vue).
10raison-sdk
Raison JavaScript/TypeScript prompt management SDK. Use when working with the `raison` npm package to render templates or query prompt data.
7