Initial commit

skills/documentation-wizard/References/readme-template.md

@@ -0,0 +1,153 @@
+# {Project Name}
+
+{Brief description of the project - one or two sentences}
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Version](https://img.shields.io/badge/version-1.0.0-green.svg)](package.json)
+
+## Overview
+
+{Detailed description of what this project does, why it exists, and what problems it solves}
+
+## Features
+
+- ✨ {Feature 1}
+- 🚀 {Feature 2}
+- 🔒 {Feature 3}
+- 📊 {Feature 4}
+
+## Quick Start
+
+### Prerequisites
+
+- Node.js 18+ (or other runtime)
+- {Other prerequisites}
+
+### Installation
+
+\`\`\`bash
+npm install
+# or
+yarn install
+\`\`\`
+
+### Basic Usage
+
+\`\`\`typescript
+import { Something } from '{package-name}';
+
+// Example code here
+const example = new Something();
+example.doSomething();
+\`\`\`
+
+## Documentation
+
+- 📖 [API Documentation](./docs/api/)
+- 🏗️ [Architecture](./docs/ARCHITECTURE.md)
+- 📋 [Architecture Decision Records](./docs/adr/)
+- 🎨 [Style Guide](./docs/STYLEGUIDE.md)
+- 🤝 [Contributing Guidelines](./CONTRIBUTING.md)
+
+## Configuration
+
+\`\`\`typescript
+{
+  // Configuration options
+  option1: "value1",
+  option2: "value2"
+}
+\`\`\`
+
+## Examples
+
+### Example 1: {Use case}
+
+\`\`\`typescript
+// Code example
+\`\`\`
+
+### Example 2: {Another use case}
+
+\`\`\`typescript
+// Code example
+\`\`\`
+
+## API Reference
+
+### Main API
+
+#### `functionName(param1, param2)`
+
+Description of what this function does.
+
+**Parameters:**
+- `param1` (type): Description
+- `param2` (type): Description
+
+**Returns:** Description of return value
+
+**Example:**
+\`\`\`typescript
+const result = functionName('value1', 'value2');
+\`\`\`
+
+## Architecture
+
+{Brief overview of the architecture}
+
+See [ARCHITECTURE.md](./docs/ARCHITECTURE.md) for detailed architecture documentation.
+
+## Development
+
+### Setup Development Environment
+
+\`\`\`bash
+npm install
+npm run dev
+\`\`\`
+
+### Running Tests
+
+\`\`\`bash
+npm test
+npm run test:coverage
+\`\`\`
+
+### Building
+
+\`\`\`bash
+npm run build
+\`\`\`
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+
+### Development Process
+
+1. Fork the repository
+2. Create a feature branch (\`git checkout -b feature/amazing-feature\`)
+3. Commit your changes (\`git commit -m 'Add amazing feature'\`)
+4. Push to the branch (\`git push origin feature/amazing-feature\`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+* {Credit to contributors}
+* {Credit to inspirations}
+* {Credit to tools/libraries used}
+
+## Support
+
+- 📧 Email: {email}
+- 💬 Issues: [GitHub Issues](https://github.com/{user}/{repo}/issues)
+- 📖 Documentation: [Full Docs](./docs/)
+
+---
+
+*Generated by Documentation Wizard • Last updated: {date}*