Merge pull request #4 from Jpisnice/refine

Refine

Author: Jpisnice

.npmignore

@@ -0,0 +1,48 @@
+# Source files (we only want the built JS files)
+src/
+tsconfig.json
+
+# Development files
+.env*
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+test-package.sh
+examples.sh
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Node modules (handled by package.json)
+node_modules/
+
+# Test files
+test/
+tests/
+*.test.js
+*.test.ts
+*.spec.js
+*.spec.ts
+
+# Documentation that's not needed in package
+docs/
+CONTRIBUTING.md
+V4_MIGRATION_SUMMARY.md
+
+# Git files
+.git/
+.gitignore

Dockerfile

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shadcn UI MCP Server
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Dockerfile.http

@@ -0,0 +1,114 @@
+# Publishing Checklist for shadcn-ui-mcp-server
+
+## ✅ Pre-Publishing Checklist
+
+- [x] Package name is unique and descriptive (`shadcn-ui-mcp-server`)
+- [x] Version is set correctly (1.0.0)
+- [x] License is included (MIT)
+- [x] README.md is comprehensive and up-to-date
+- [x] Binary (`shadcn-mcp`) is correctly configured in package.json
+- [x] Main entry point is set correctly
+- [x] Files array or .npmignore excludes unnecessary files
+- [x] Keywords are relevant for discoverability
+- [x] Repository URL is set (update with actual URL)
+- [x] Author information is set (update with actual info)
+- [x] Dependencies are correctly specified
+- [x] Build script works (`npm run build`)
+- [x] CLI help works (`./build/index.js --help`)
+- [x] CLI version works (`./build/index.js --version`)
+- [x] Test script passes (`npm test`)
+
+## 📝 Before Publishing
+
+1. **Update package.json with your info:**
+   ```bash
+   # Update these fields:
+   - author: "Your Name <[email protected]>"
+   - repository.url: "git+https://github.com/yourusername/shadcn-ui-mcp-server.git"
+   - bugs.url: "https://github.com/yourusername/shadcn-ui-mcp-server/issues"
+   - homepage: "https://github.com/yourusername/shadcn-ui-mcp-server#readme"
+   ```
+
+2. **Check package name availability:**
+   ```bash
+   npm view shadcn-ui-mcp-server
+   # Should return "npm ERR! 404 Not Found" if available
+   ```
+
+3. **Final build and test:**
+   ```bash
+   npm run clean
+   npm run build
+   npm test
+   ```
+
+## 🚀 Publishing Steps
+
+1. **Login to npm:**
+   ```bash
+   npm login
+   ```
+
+2. **Publish the package:**
+   ```bash
+   npm publish
+   ```
+
+3. **Test the published package:**
+   ```bash
+   npx shadcn-ui-mcp-server --help
+   ```
+
+## 🔄 Post-Publishing
+
+1. **Update version for next release:**
+   ```bash
+   npm version patch  # for bug fixes
+   npm version minor  # for new features
+   npm version major  # for breaking changes
+   ```
+
+2. **Create GitHub release (if using GitHub):**
+   - Tag the release
+   - Add release notes
+   - Mention the npm package
+
+## 📊 Usage Examples
+
+After publishing, users can:
+
+```bash
+# Install globally
+npm install -g shadcn-ui-mcp-server
+
+# Or use with npx (recommended)
+npx shadcn-ui-mcp-server --help
+npx shadcn-ui-mcp-server --github-api-key YOUR_TOKEN
+```
+
+## 🎯 Integration Examples
+
+**Claude Desktop:**
+```json
+{
+  "mcpServers": {
+    "shadcn-ui": {
+      "command": "npx",
+      "args": ["shadcn-ui-mcp-server", "--github-api-key", "YOUR_TOKEN"]
+    }
+  }
+}
+```
+
+**Continue.dev:**
+```json
+{
+  "tools": [{
+    "name": "shadcn-ui",
+    "type": "mcp",
+    "command": "npx",
+    "args": ["shadcn-ui-mcp-server"],
+    "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_TOKEN"}
+  }]
+}
+```