Smart Prompts MCP Server

--- name: readme_generator title: README Generator description: Generate comprehensive README files for projects with all essential sections category: documentation tags: [documentation, readme, markdown, open-source, project] difficulty: beginner author: jezweb version: 1.0.0 arguments: - name: project_name description: Name of the project required: true - name: project_type description: Type of project (library, application, cli, api) required: true - name: language description: Primary programming language required: true - name: license description: License type (MIT, Apache-2.0, GPL-3.0, ISC) required: false default: MIT - name: features description: Key features (comma-separated) required: false --- # {{project_name}} [](https://opensource.org/licenses/{{license}}) [](https://github.com/{{project_name}}) [](https://github.com/username/{{project_name}}/actions) [](https://codecov.io/gh/username/{{project_name}}) ## Overview Brief description of what {{project_name}} does and why it exists. This {{project_type}} provides [main value proposition]. {{#if features}} ## Features {{#each (split features ",")}} - ✨ {{trim this}} {{/each}} {{else}} ## Features - 🚀 Fast and efficient - 🔧 Easy to configure - 📚 Well documented - 🧪 Thoroughly tested - 🔄 Active development {{/if}} ## Table of Contents - [Installation](#installation) - [Quick Start](#quick-start) - [Usage](#usage) - [API Reference](#api-reference) - [Configuration](#configuration) - [Examples](#examples) - [Development](#development) - [Contributing](#contributing) - [License](#license) ## Installation {{#if (eq project_type "library")}} ### Package Manager {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} ```bash # npm npm install {{project_name}} # yarn yarn add {{project_name}} # pnpm pnpm add {{project_name}} ``` {{else if (eq language "Python")}} ```bash # pip pip install {{project_name}} # poetry poetry add {{project_name}} # pipenv pipenv install {{project_name}} ``` {{else if (eq language "Ruby")}} ```bash # gem gem install {{project_name}} # Bundler bundle add {{project_name}} ``` {{else if (eq language "Java")}} ```xml <!-- Maven --> <dependency> <groupId>com.example</groupId> <artifactId>{{project_name}}</artifactId> <version>1.0.0</version> </dependency> ``` ```gradle // Gradle implementation 'com.example:{{project_name}}:1.0.0' ``` {{else if (eq language "Go")}} ```bash go get github.com/username/{{project_name}} ``` {{else if (eq language "Rust")}} ```toml # Cargo.toml [dependencies] {{project_name}} = "1.0.0" ``` {{/if}} {{else}} ### From Source ```bash # Clone the repository git clone https://github.com/username/{{project_name}}.git cd {{project_name}} {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} # Install dependencies npm install # Build the project npm run build {{else if (eq language "Python")}} # Install dependencies pip install -r requirements.txt # Install in development mode pip install -e . {{else if (eq language "Go")}} # Build the binary go build -o {{project_name}} {{else if (eq language "Rust")}} # Build the project cargo build --release {{/if}} ``` {{/if}} ## Quick Start {{#if (eq project_type "library")}} ```{{lowercase language}} {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} import { main } from '{{project_name}}'; // Basic usage const result = main('Hello, World!'); console.log(result); {{else if (eq language "Python")}} from {{project_name}} import main # Basic usage result = main("Hello, World!") print(result) {{else if (eq language "Go")}} import "github.com/username/{{project_name}}" func main() { result := {{project_name}}.Main("Hello, World!") fmt.Println(result) } {{else if (eq language "Java")}} import com.example.{{project_name}}.Main; public class Example { public static void main(String[] args) { String result = Main.process("Hello, World!"); System.out.println(result); } } {{/if}} ``` {{else if (eq project_type "cli")}} ```bash # Basic command {{project_name}} --help # Example usage {{project_name}} process input.txt -o output.txt # With options {{project_name}} --verbose --format json process data.csv ``` {{else if (eq project_type "api")}} ```bash # Start the server {{project_name}} serve --port 8080 # Make a request curl http://localhost:8080/api/v1/health # With authentication curl -H "Authorization: Bearer TOKEN" http://localhost:8080/api/v1/resource ``` {{/if}} ## Usage ### Basic Example Detailed example showing common use case: {{#if (eq project_type "library")}} ```{{lowercase language}} // More comprehensive example // [Add code example here] ``` {{else}} ```bash # Command line example {{project_name}} [command] [options] ``` {{/if}} ### Advanced Usage For more advanced scenarios: 1. **Feature 1**: Description of how to use 2. **Feature 2**: Description of how to use 3. **Feature 3**: Description of how to use ## API Reference {{#if (eq project_type "library")}} ### Main Functions #### `functionName(param1, param2)` Description of what the function does. **Parameters:** - `param1` (Type): Description - `param2` (Type): Description **Returns:** - `Type`: Description of return value **Example:** ```{{lowercase language}} const result = functionName(value1, value2); ``` {{else if (eq project_type "api")}} ### Endpoints #### `GET /api/v1/resource` Retrieve resources. **Parameters:** - `limit` (integer): Maximum number of results - `offset` (integer): Pagination offset **Response:** ```json { "data": [], "total": 0, "limit": 10, "offset": 0 } ``` {{/if}} ## Configuration {{#if (eq project_type "application")}} ### Environment Variables | Variable | Description | Default | |----------|-------------|---------| | `PORT` | Server port | `3000` | | `LOG_LEVEL` | Logging level | `info` | | `DATABASE_URL` | Database connection | - | ### Configuration File Create a `config.yaml` file: ```yaml server: port: 3000 host: localhost database: url: postgresql://localhost/mydb logging: level: info format: json ``` {{else}} Configuration options can be set via: 1. Configuration file 2. Environment variables 3. Command line arguments See [Configuration Guide](docs/configuration.md) for details. {{/if}} ## Examples Find more examples in the [`examples/`](examples/) directory: - [Basic Usage](examples/basic/) - [Advanced Features](examples/advanced/) - [Integration Examples](examples/integration/) ## Development ### Prerequisites {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} - Node.js >= 14.0.0 - npm or yarn {{else if (eq language "Python")}} - Python >= 3.8 - pip or poetry {{else if (eq language "Go")}} - Go >= 1.19 {{else if (eq language "Java")}} - Java >= 11 - Maven or Gradle {{else if (eq language "Rust")}} - Rust >= 1.70.0 - Cargo {{/if}} ### Setup ```bash # Clone the repository git clone https://github.com/username/{{project_name}}.git cd {{project_name}} # Install dependencies {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} npm install {{else if (eq language "Python")}} pip install -r requirements-dev.txt {{else if (eq language "Go")}} go mod download {{else if (eq language "Rust")}} cargo build {{/if}} # Run tests {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} npm test {{else if (eq language "Python")}} pytest {{else if (eq language "Go")}} go test ./... {{else if (eq language "Rust")}} cargo test {{/if}} ``` ### Project Structure ``` {{project_name}}/ {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} ├── src/ # Source code ├── tests/ # Test files ├── docs/ # Documentation ├── examples/ # Example code ├── package.json # Package configuration └── README.md # This file {{else if (eq language "Python")}} ├── {{project_name}}/ # Source code ├── tests/ # Test files ├── docs/ # Documentation ├── examples/ # Example code ├── setup.py # Package configuration └── README.md # This file {{else if (eq language "Go")}} ├── cmd/ # Command line apps ├── pkg/ # Public packages ├── internal/ # Private packages ├── docs/ # Documentation ├── go.mod # Module definition └── README.md # This file {{/if}} ``` ## Contributing We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details. ### How to Contribute 1. Fork the repository 2. Create your feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add some amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ### Code Style {{#if (or (eq language "JavaScript") (eq language "TypeScript"))}} We use ESLint and Prettier for code formatting. Run `npm run lint` before submitting. {{else if (eq language "Python")}} We follow PEP 8 style guide. Run `flake8` and `black` before submitting. {{else if (eq language "Go")}} Run `go fmt` and `golint` before submitting. {{/if}} ## Roadmap - [ ] Feature 1 - Description - [ ] Feature 2 - Description - [ ] Feature 3 - Description - [ ] Performance improvements - [ ] Additional documentation See the [open issues](https://github.com/username/{{project_name}}/issues) for a full list of proposed features. ## Support - 📧 Email: support@example.com - 💬 Discord: [Join our server](https://discord.gg/example) - 📖 Documentation: [docs.example.com](https://docs.example.com) - 🐛 Issues: [GitHub Issues](https://github.com/username/{{project_name}}/issues) ## License This project is licensed under the {{license}} License - see the [LICENSE](LICENSE) file for details. ## Acknowledgments - Thanks to all contributors - Inspired by [similar-project] - Built with [key-technology] --- Made with ❤️ by [Your Name](https://github.com/username)