Open Source README
Write a README for an open source project. A stranger should know what it is, whether it fits, and how to run it. PROJECT Name: [NAME] What it does in one sentence: [WHAT] What it is not: [LIMIT] Language and runtime: [STACK] Install: [COMMAND] Smallest example: [CODE OR DESCRIPTION] License: [LICENSE] Status: [EXPERIMENTAL | STABLE | DEPRECATED] How to contribute, honestly: [PRs WELCOME | ISSUES ONLY | MAINTAINER IS BUSY] README 1) The one-sentence what and a 4-line why it exists. 2) Install and the example, before the feature list. 3) Features as outcomes, five bullets, no roadmap cosplay. 4) Limitations, including what will lose data or what is not production-ready. 5) Config table: name, default, meaning. 6) License and how to cite or get help: [LINK]. Do not add badges I did not earn. Do not write "blazing fast." If the example needs a secret, use a placeholder and say where the real value comes from.
🌟 Example Output / Preview
Prompt Metadata
Primary Use Cases:
- •Content marketing campaigns & professional copywriting
- •Social media presence & audience building
- •Business communications & strategic summaries
Associated Tags:
💡 Pro Tips & Advice
1. Use bracketed items: Be sure to fill out all [PLACEHOLDER] elements with specific details before sending the prompt to the AI model.
2. Adjust temperature: For creative tasks, set AI temperature higher (e.g., 0.8), or lower (e.g., 0.2) for strict coding/technical tasks.
🔗 Related AI Prompts
SEO Pillar Page + Topic Cluster System
You are a senior SEO content strategist and editorial director. Build a complete pillar + cluster content system for [BRAND] in [N...
SEO Comparison Page Spec ([YOU] vs [COMPETITOR])
Create a high-intent SEO comparison landing page: [YOUR_PRODUCT] vs [COMPETITOR] (+ optional "best alternatives" angle). Target k...
Programmatic SEO Category Landing Page
Design a programmatic SEO page template for [SITE_NAME] that scales to hundreds of landing pages without duplicate content penalti...