loopwind 0.12.0 → 0.12.2

package/TEMPLATE_SOURCES.md

@@ -1,347 +0,0 @@
-# Installing Templates from Different Sources
-
-## Overview
-
-loopwind supports installing templates from multiple sources:
-
-1. **Official Registry** (default)
-2. **Direct URLs**
-3. **GitHub Repositories**
-4. **Local Filesystem**
-
-## 1. Official Registry (Default)
-
-Install templates from the official loopwind registry at `https://loopwind.dev/r`
-
-```bash
-loopwind add banner-hero
-loopwind add product-card
-loopwind add social-og-image
-```
-
-**How it works:**
-- Fetches from: `https://loopwind.dev/r/banner-hero`
-- Returns JSON with template files
-- Installs to: `loopwind/templates/banner-hero/`
-
-### Custom Registry
-
-Use a different registry:
-
-```bash
-loopwind add banner-hero --registry https://my-registry.com/templates
-```
-
-## 2. Direct URLs
-
-Install a template from any publicly accessible URL:
-
-```bash
-loopwind add https://example.com/templates/my-template.json
-loopwind add https://cdn.example.com/templates/awesome-banner.json
-```
-
-**Requirements:**
-- URL must return JSON in the registry template format
-- Must be publicly accessible (no authentication)
-
-**Example template JSON:**
-
-```json
-{
-  "name": "my-template",
-  "version": "1.0.0",
-  "description": "My custom template",
-  "files": [
-    {
-      "path": "template.tsx",
-      "content": "export const meta = {...};\n\nexport default function..."
-    }
-  ]
-}
-```
-
-## 3. GitHub Repositories
-
-Install templates directly from GitHub repos:
-
-```bash
-# From a GitHub repo (looks for template.json in repo root)
-loopwind add github:username/repo
-
-# From a specific path in the repo
-loopwind add github:username/repo/templates/banner-hero
-
-# From an organization
-loopwind add github:myorg/design-templates/social-media/og-image
-```
-
-**How it works:**
-- Converts to raw GitHub URLs
-- Fetches `template.json` from the specified path
-- Downloads all referenced files
-- Uses `main` branch by default
-
-**Example repo structure:**
-
-```
-username/repo/
-└── template.tsx    # Contains export const meta + component
-```
-
-Or with path:
-
-```
-username/repo/
-└── templates/
-    └── banner-hero/
-        └── template.tsx    # Contains export const meta + component
-```
-
-**template.json format (for registry):**
-
-```json
-{
-  "name": "banner-hero",
-  "version": "1.0.0",
-  "description": "Hero banner template",
-  "files": [
-    {
-      "path": "template.tsx",
-      "content": "export const meta = {...};\n\nexport default function..."
-    }
-  ]
-}
-```
-
-## 4. Local Filesystem
-
-Install templates from your local filesystem:
-
-```bash
-# Relative path
-loopwind add ./my-templates/banner-hero
-loopwind add ../shared-templates/product-card
-
-# Absolute path
-loopwind add /Users/you/templates/social-card
-```
-
-**Requirements:**
-- Directory must contain `template.tsx` with `export const meta`
-- Or a single file `template-name.tsx` with `export const meta`
-- All template files should be in the directory
-
-**Example local structure:**
-
-```
-my-templates/banner-hero/
-├── template.tsx        # Contains export const meta + component
-└── assets/
-    └── logo.png
-```
-
-**Use cases:**
-- Development and testing
-- Private templates
-- Shared team templates (monorepo)
-- Before publishing to registry
-
-## Template Format
-
-All sources must provide templates in this format:
-
-```typescript
-interface RegistryTemplate {
-  name: string;
-  version: string;
-  description: string;
-  files: Array<{
-    path: string;      // Relative path within template folder
-    content: string;   // File contents
-  }>;
-}
-```
-
-## Examples
-
-### Example 1: Company Templates on GitHub
-
-```bash
-# Install from company repo
-loopwind add github:mycompany/design-templates/marketing/hero-banner
-
-# Result: Installs to loopwind/templates/hero-banner/
-```
-
-### Example 2: Local Development
-
-```bash
-# Create template locally
-mkdir -p my-template
-cd my-template
-
-# Create template.tsx with export const meta
-# ...
-
-# Install from local
-cd ../my-project
-loopwind add ../my-template
-
-# Test it
-loopwind render banner --props props.json
-```
-
-### Example 3: Direct URL
-
-```bash
-# Install from CDN
-loopwind add https://cdn.mycompany.com/templates/v2/social-card.json
-
-# Install from gist (if formatted correctly)
-loopwind add https://gist.githubusercontent.com/user/id/raw/template.json
-```
-
-### Example 4: Custom Registry
-
-```bash
-# Team's private registry
-loopwind add product-card --registry https://templates.mycompany.com/api
-
-# Alternative registry
-loopwind add banner --registry https://awesome-templates.dev/registry
-```
-
-## Creating Shareable Templates
-
-### For GitHub
-
-1. Create a repo with your templates:
-
-```
-my-templates/
-├── README.md
-└── templates/
-    ├── banner-hero/
-    │   └── template.tsx    # Contains export const meta + component
-    └── product-card/
-        └── template.tsx    # Contains export const meta + component
-```
-
-2. Share installation command:
-
-```bash
-loopwind add github:username/my-templates/templates/banner-hero
-```
-
-### For Direct URL
-
-1. Host template JSON on a CDN or static site
-2. Ensure CORS headers allow access
-3. Share the URL:
-
-```bash
-loopwind add https://my-cdn.com/templates/banner.json
-```
-
-### For Local Sharing (Teams)
-
-1. Create templates in shared monorepo:
-
-```
-company-monorepo/
-├── apps/
-├── packages/
-└── design-templates/
-    ├── banner/
-    ├── card/
-    └── hero/
-```
-
-2. Team members install with relative paths:
-
-```bash
-loopwind add ../../design-templates/banner
-```
-
-## Security Considerations
-
-### URLs
-- Only download from trusted sources
-- Review template code before using
-- URLs should use HTTPS
-
-### GitHub
-- Templates from public repos only
-- Review repository before installing
-- Check template contents
-
-### Local
-- Most secure option
-- Full control over template code
-- Good for development/testing
-
-## Troubleshooting
-
-### "Failed to fetch template"
-
-**Registry:**
-- Check template name spelling
-- Verify registry is accessible
-- Try custom registry with `--registry`
-
-**URL:**
-- Ensure URL is publicly accessible
-- Check URL returns valid JSON
-- Verify CORS headers
-
-**GitHub:**
-- Check repo and path exist
-- Ensure `template.json` exists
-- Verify repo is public
-- Branch must be `main`
-
-**Local:**
-- Check path is correct
-- Ensure `template.tsx` exists with `export const meta`
-- Verify file permissions
-
-### "Template already installed"
-
-Delete existing template and reinstall:
-
-```bash
-rm -rf loopwind/templates/banner-hero
-loopwind add github:user/repo/banner-hero
-```
-
-## Advanced: Publishing Your Own Registry
-
-Create a registry server that responds to:
-
-```
-GET /your-template
-```
-
-Returns:
-
-```json
-{
-  "name": "your-template",
-  "version": "1.0.0",
-  "description": "...",
-  "files": [...]
-}
-```
-
-Users can install with:
-
-```bash
-loopwind add your-template --registry https://your-registry.com
-```
-
-See `ROADMAP.md` for future registry features (versioning, search, marketplace).
-
----
-
-**Pro tip:** Start with local development, then move to GitHub for sharing, and eventually publish to the official registry!