docs: fix installation instructions for official methods

- Replace pluginMarketplace with extraKnownMarketplaces - Add CLI command method (recommended) - Add settings.json method for team distribution - Add local development option - Prioritize public HTTPS URL over Tailscale SSH URL - Reorganize installation sections for clarity Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-20 09:56:41 -05:00
parent 1adb434c58
commit 72941c1fe1
1 changed files with 78 additions and 52 deletions
--- a/README.md
+++ b/README.md
@@ -89,67 +89,92 @@ Comprehensive NetBox REST API integration for infrastructure management.
 - Python 3.10+
 - Access to target services (Gitea, NetBox as needed)

-### Quick Start
+### Add Marketplace to Claude Code

-1. **Clone the repository:**
-   ```bash
-   git clone ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git
-   cd support-claude-mktplace
-   ```
+**Option 1 - CLI command (recommended):**
+```bash
+/plugin marketplace add https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git
+```

-2. **Install MCP server dependencies:**
-   ```bash
-   # Gitea MCP (for projman)
-   cd plugins/projman/mcp-servers/gitea
-   python3 -m venv .venv
-   source .venv/bin/activate
-   pip install -r requirements.txt
-   deactivate
+**Option 2 - Settings file (for team distribution):**

-   # NetBox MCP (for cmdb-assistant)
-   cd ../../../cmdb-assistant/mcp-servers/netbox
-   python3 -m venv .venv
-   source .venv/bin/activate
-   pip install -r requirements.txt
-   deactivate
-   ```
+Add to `.claude/settings.json` in your target project:
+```json
+{
+  "extraKnownMarketplaces": {
+    "support-claude-mktplace": {
+      "source": {
+        "source": "git",
+        "url": "https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git"
+      }
+    }
+  }
+}
+```

-3. **Configure system-level credentials:**
-   ```bash
-   mkdir -p ~/.config/claude
+**Option 3 - Local development:**
+```bash
+# Clone the repository first
+git clone https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git

-   # Gitea credentials
-   cat > ~/.config/claude/gitea.env << 'EOF'
-   GITEA_URL=https://gitea.example.com
-   GITEA_TOKEN=your_token
-   GITEA_ORG=your_org
-   EOF
+# Then add from local path
+/plugin marketplace add /path/to/support-claude-mktplace
+```

-   # NetBox credentials
-   cat > ~/.config/claude/netbox.env << 'EOF'
-   NETBOX_API_URL=https://netbox.example.com/api
-   NETBOX_API_TOKEN=your_token
-   EOF
+**Alternative SSH URL (for authenticated access):**
+```
+ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git
+```

-   chmod 600 ~/.config/claude/*.env
-   ```
+### Configure MCP Server Dependencies

-4. **Configure project-level settings:**
-   ```bash
-   # In your target project root
-   cat > .env << 'EOF'
-   GITEA_REPO=your-repository-name
-   EOF
-   ```
+If using plugins with MCP servers (projman, cmdb-assistant), install dependencies:

-5. **Add marketplace to Claude Code:**
+```bash
+# Gitea MCP (for projman)
+cd plugins/projman/mcp-servers/gitea
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+deactivate

-   Add to your project's `.claude/settings.json`:
-   ```json
-   {
-     "pluginMarketplace": "/path/to/support-claude-mktplace"
-   }
-   ```
+# NetBox MCP (for cmdb-assistant)
+cd ../../../cmdb-assistant/mcp-servers/netbox
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+deactivate
+```
+
+### Configure Credentials
+
+**System-level credentials:**
+```bash
+mkdir -p ~/.config/claude
+
+# Gitea credentials
+cat > ~/.config/claude/gitea.env << 'EOF'
+GITEA_URL=https://gitea.example.com
+GITEA_TOKEN=your_token
+GITEA_ORG=your_org
+EOF
+
+# NetBox credentials
+cat > ~/.config/claude/netbox.env << 'EOF'
+NETBOX_API_URL=https://netbox.example.com/api
+NETBOX_API_TOKEN=your_token
+EOF
+
+chmod 600 ~/.config/claude/*.env
+```
+
+**Project-level settings:**
+```bash
+# In your target project root
+cat > .env << 'EOF'
+GITEA_REPO=your-repository-name
+EOF
+```

 ## Repository Structure

@@ -217,4 +242,5 @@ MIT License
 ## Support

 - **Issues**: Contact repository maintainer
- **Repository**: `ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git`
+- **Repository**: `https://gitea.hotserv.cloud/personal-projects/support-claude-mktplace.git`
+- **SSH URL**: `ssh://git@hotserv.tailc9b278.ts.net:2222/personal-projects/support-claude-mktplace.git`