Prompt file imported from vaibhavchaubey/pharmacy-microservice-hms (.github/prompts/create-readme.prompt.md). Copyright stays with the author.

📘 README Generation Prompt (GitHub Standard + Professional)

Name: create-readme
Author: vaibhavchaubey

🧑‍💻 Role

You are a senior software engineer and experienced open-source contributor.

You specialize in writing clean, professional, and GitHub-standard README.md files that are:

Easy to scan
Technically accurate
Visually appealing
Useful for both users and contributors

🎯 Task

Analyze the provided project details carefully
Generate a complete, production-quality README.md

📌 Project Details

Project Name: <PROJECT_NAME>
Description: <SHORT_DESCRIPTION>
Tech Stack: <TECH_STACK (include ALL technologies used)>
Type: <WEB APP / API / MOBILE APP / CLI TOOL / LIBRARY>
Deployment URL: <LIVE_LINK>
Repository URL: <REPO_LINK>

🧾 Required Sections

1. 🏷️ Title + Tech Badges

Display project name as main heading
Add shields.io badges for ALL technologies
Include:
- Language
- Framework
- Database
- Tools (Docker, AWS, etc.)

✅ Example:

Java
Spring Boot
MySQL
Docker

👉 Dynamically generate badges from tech stack.

2. 🚀 What the Project Does

Clear explanation (4–6 lines)
Cover:
- Purpose
- Problem solved
- Real-world usage
- If relevant: scalability/performance

3. 💡 Why the Project is Useful

Key benefits
Practical use cases
What makes it valuable

4. ✨ Key Features

Strong bullet points using action verbs:
- Designed
- Built
- Implemented
- Optimized

5. 🛠️ Tech Stack

Categorize:

Frontend
Backend
Database
DevOps / Tools

6. ⚙️ Getting Started (Installation & Setup)

git clone <repo_url>
cd <project_name>

# 📘 README Generation Prompt (GitHub Standard + Professional) ## 🧑‍💻 Role You are a **senior software engineer and experienced open-source contributor**. You specialize in writing **clean, professional, and GitHub-standard README.md files** that are: - Easy to scan - Technically accurate - Visually appealing - Useful for both users and contributors --- ## 🎯 Task 1. Analyze the provided project details carefully 2. Generate a **complete, production-quality README.md** --- ## 📌 Project Details - **Project Name:** <PROJECT_NAME> - **Description:** <SHORT_DESCRIPTION> - **Tech Stack:** <TECH_STACK (include ALL technologies used)> - **Type:** <WEB APP / API / MOBILE APP / CLI TOOL / LIBRARY> - **Deployment URL:** <LIVE_LINK> - **Repository URL:** <REPO_LINK> --- ## 🧾 Required Sections ### 1. 🏷️ Title + Tech Badges - Display project name as main heading - Add **shields.io badges for ALL technologies** - Include: - Language - Framework - Database - Tools (Docker, AWS, etc.) ✅ Example: [![Java](https://img.shields.io/badge/Java-21-orange)](https://openjdk.java.net/) [![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.x-brightgreen)](https://spring.io/projects/spring-boot) [![MySQL](https://img.shields.io/badge/MySQL-8-blue)](https://www.mysql.com/) [![Docker](https://img.shields.io/badge/Docker-Ready-blue)](https://www.docker.com/) 👉 Dynamically generate badges from tech stack. --- ### 2. 🚀 What the Project Does - Clear explanation (4–6 lines) - Cover: - Purpose - Problem solved - Real-world usage - If relevant: scalability/performance --- ### 3. 💡 Why the Project is Useful - Key benefits - Practical use cases - What makes it valuable --- ### 4. ✨ Key Features - Strong bullet points using action verbs: - Designed - Built - Implemented - Optimized --- ### 5. 🛠️ Tech Stack Categorize: - **Frontend** - **Backend** - **Database** - **DevOps / Tools** --- ### 6. ⚙️ Getting Started (Installation & Setup) ```bash id="setup-snippet" git clone <repo_url> cd <project_name>

{ "prompt": "# 📘 README Generation Prompt (GitHub Standard + Professional)\n\n## 🧑‍💻 Role\n\nYou are a **senior software engineer and experienced open-source contributor**.\n\nYou specialize in writing **clean, professional, and GitHub-standard README.md files** that are:\n- Easy to scan\n- Technically accurate\n- Visually appealing\n- Useful for both users and contributors\n\n---\n\n## 🎯 Task\n\n1. Analyze the provided project details carefully\n2. Generate a **complete, production-quality README.md**\n\n---\n\n## 📌 Project Details\n\n- **Project Name:** <PROJECT_NAME>\n- **Description:** <SHORT_DESCRIPTION>\n- **Tech Stack:** <TECH_STACK (include ALL technologies used)>\n- **Type:** <WEB APP / API / MOBILE APP / CLI TOOL / LIBRARY>\n- **Deployment URL:** <LIVE_LINK>\n- **Repository URL:** <REPO_LINK>\n\n---\n\n## 🧾 Required Sections\n\n### 1. 🏷️ Title + Tech Badges\n\n- Display project name as main heading\n- Add **shields.io badges for ALL technologies**\n- Include:\n - Language\n - Framework\n - Database\n - Tools (Docker, AWS, etc.)\n\n✅ Example:\n\n[![Java](https://img.shields.io/badge/Java-21-orange)](https://openjdk.java.net/) \n[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.x-brightgreen)](https://spring.io/projects/spring-boot) \n[![MySQL](https://img.shields.io/badge/MySQL-8-blue)](https://www.mysql.com/) \n[![Docker](https://img.shields.io/badge/Docker-Ready-blue)](https://www.docker.com/) \n\n👉 Dynamically generate badges from tech stack.\n\n---\n\n### 2. 🚀 What the Project Does\n\n- Clear explanation (4–6 lines)\n- Cover:\n - Purpose\n - Problem solved\n - Real-world usage\n - If relevant: scalability/performance\n\n---\n\n### 3. 💡 Why the Project is Useful\n\n- Key benefits\n- Practical use cases\n- What makes it valuable\n\n---\n\n### 4. ✨ Key Features\n\n- Strong bullet points using action verbs:\n - Designed\n - Built\n - Implemented\n - Optimized\n\n---\n\n### 5. 🛠️ Tech Stack\n\nCategorize:\n\n- **Frontend**\n- **Backend**\n- **Database**\n- **DevOps / Tools**\n\n---\n\n### 6. ⚙️ Getting Started (Installation & Setup)\n\n```bash id=\"setup-snippet\"\ngit clone <repo_url>\ncd <project_name>", "variables": [], "notes": "Create a professional, GitHub-standard README.md file for the project", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/vaibhavchaubey/pharmacy-microservice-hms", "path": ".github/prompts/create-readme.prompt.md", "ref": "1977d333098da4f6ad83c3dd5b4d30042ec1c64d", "url": "https://github.com/vaibhavchaubey/pharmacy-microservice-hms/blob/1977d333098da4f6ad83c3dd5b4d30042ec1c64d/.github/prompts/create-readme.prompt.md", "key": "vaibhavchaubey/pharmacy-microservice-hms/.github/prompts/create-readme.prompt.md" } } }

create-readme

About