From 40f311796b1b03c41762e783a2e5242cd076545a Mon Sep 17 00:00:00 2001 From: wc24 Date: Sat, 23 May 2026 16:21:54 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20install=20=E6=8C=87=E4=BB=A4=E6=8E=A8?= =?UTF-8?q?=E8=8D=90=20http,=E8=A1=A5=20ts=20=E8=BF=90=E8=A1=8C=E5=99=A8?= =?UTF-8?q?=E8=A6=81=E6=B1=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README 的 install 块原来只有 ssh,内网用户不一定都配了 ssh key。改成 http 优先,ssh 备选。同时补一句消费方需要 tsx/ts-node —— 仓库 ship .ts 源,装完就能 import 但 node 直接跑会炸。 下一步打 v0.1.0 tag 让这条指令真能用。 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8a97908..58a3fe5 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,15 @@ cd examples/basic-admin && npm install && npm start ## 在你的项目里用 ```sh +# 推荐: HTTP(任何能访问 git.zeromvc.com 的机器都能用) +npm install git+http://git.zeromvc.com/wc24/shrimp-server.git#v0.1.0 + +# 也可以 SSH(需要 ssh key 配好) npm install git+ssh://git@git.zeromvc.com:wc24/shrimp-server.git#v0.1.0 ``` +> 仓库 ship `.ts` 源码,消费方项目需要 TS 运行器(`tsx` / `ts-node`)或在打包工具(vite / webpack / esbuild)里能解析 `.ts`。 + ```ts import { ShrimpServer, ShrimpTableModule, MongoShrimpCrud, ShrimpFieldTypes } from "shrimp-server" // ↓ 详见下面"想做什么"指南