npm package: @julianoczkowski/my-rules
Description: Personal development rules, guidelines, and documentation for coding projects
Author: Julian Oczkowski
Latest version: 1.5.0

# My Rules

Personal development rules, guidelines, and documentation for coding projects. This package provides a simple way to share and distribute development standards, Cursor IDE rules, and MCP server configurations.

## 🚀 Features

- **📚 Development Rules** - Comprehensive coding guidelines and best practices
- **🎯 Cursor Rules** - IDE-specific configuration and development standards
- **🔧 MCP Server Configurations** - Ready-to-use server setups and examples
- **📱 Dynamic Download** - Fetches latest content from GitHub repository on install
- **🖥️ Easy Distribution** - Simple NPM-based sharing and installation
- **🔄 Future-Proof** - Supports adding new documentation without code changes

## 📦 Installation

### NPX Install (Recommended)

```bash
# Interactive mode - choose which folders to download
npx @julianoczkowski/my-rules

# Auto-download all folders (non-interactive)
npx @julianoczkowski/my-rules --auto

# Show help
npx @julianoczkowski/my-rules --help
```

## 🎯 How It Works

The package now offers **interactive folder selection**:

1. **Interactive Mode** - Choose which documentation folders to download
2. **Auto Mode** - Download all available folders automatically
3. **Dynamic Discovery** - Automatically detects available documentation folders
4. **Future-Proof** - Ready for new folders like "VS Code Rules" when added
5. **Always Current** - Gets the latest version of rules and documentation from the repo

## 📁 What You Get

After installation, you'll have access to:

```
Cursor Rules/
├── user_rules.md          # Complete development standards and practices
└── mcp_servers.md         # MCP server configurations and examples
```

## 🔧 Usage

### Interactive Mode (Default)

When you run the package interactively, you'll see a menu like this:

```
📁 Available Documentation Folders:
==================================================

1. Cursor Rules
   IDE-specific configuration and development standards for Cursor

🎯 Selection Options:
  • Enter numbers separated by commas (e.g., 1,3) to select specific folders
  • Enter 'all' to download everything
  • Enter 'none' to skip download

👉 What would you like to download?
```

### Auto Mode

For automated installations or CI/CD, use the `--auto` flag to download all available folders without prompts.

### Postinstall Behavior

During `npm install`, the package automatically downloads all folders (non-interactive mode) to avoid blocking the installation process.

## 📋 Content Overview

### Development Rules (`user_rules.md`)

- Mandatory todo list creation and task management
- Implementation guide creation for major features
- Communication and progress tracking standards
- Development standards and code quality guidelines
- Project consistency and pattern following
- Quality assurance and completion standards

### MCP Server Configurations (`mcp_servers.md`)

- Context7 - AI Context Management
- GitHub - Repository Integration
- Supabase - Database Operations
- AWS Knowledge Base - Cloud Documentation
- Firecrawl - Web Scraping
- Microsoft Docs - Technical Documentation
- Chrome DevTools - Browser Development
- Modus Docs - Design System Documentation

## 🚀 For Package Maintainers

### Adding New Content

Simply add new files or folders to the GitHub repository. The download script will automatically include them in future installations without requiring code changes.

### Publishing Updates

1. Update version in `package.json`
2. Create a git tag: `git tag v1.0.1`
3. Push the tag: `git push origin v1.0.1`
4. GitHub Actions will automatically publish to NPM

## 🛠️ Technical Details

- **Node.js**: Requires Node.js 18 or higher
- **Dynamic Fetching**: Uses GitHub API to discover and download content
- **Recursive Structure**: Maintains complete folder hierarchy
- **Error Handling**: Graceful handling of network issues and missing files
- **Filtering**: Automatically excludes development files (.git, node_modules, etc.)

## 📄 License

MIT License - feel free to use and modify as needed.

## 🤝 Contributing

This is a personal rules repository, but suggestions and improvements are welcome via GitHub issues.

## 🔗 Links

- [GitHub Repository](https://github.com/julianoczkowski/my-rules)
- [NPM Package](https://www.npmjs.com/package/@julianoczkowski/my-rules)
- [Issues](https://github.com/julianoczkowski/my-rules/issues)