Skip to content

Commit 36ecf89

Browse files
refactor: reposition as Docker distribution for mcp-remote
- Replace npm-focused README with Docker-focused documentation - Move npm documentation to README.npm.md for reference - Remove npm publish workflow (not needed for Docker distribution) - Add comprehensive Docker usage examples for all MCP clients - Document multi-platform support and ghcr.io publishing - Update workflow documentation to clarify Docker focus
1 parent 900b43f commit 36ecf89

5 files changed

Lines changed: 278 additions & 255 deletions

File tree

.github/workflows/check.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
name: Check
22

3+
# This workflow ensures code quality by running prettier formatting checks
4+
# and TypeScript type checking on all pull requests
35
on:
46
pull_request:
57
branches:

.github/workflows/docker.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
name: Build and Publish Docker Image
22

3+
# This workflow builds multi-platform Docker images and publishes them to
4+
# GitHub Container Registry (ghcr.io). Images are built for linux/amd64 and
5+
# linux/arm64 platforms.
6+
#
7+
# Images are published on:
8+
# - Push to main branch (tagged as 'main' and 'latest')
9+
# - Version tags (tagged as version number)
10+
# - NOT published on pull requests (build only for validation)
311
on:
412
push:
513
branches:

.github/workflows/publish.yml

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)