docs: install 指令推荐 http,补 ts 运行器要求

README 的 install 块原来只有 ssh,内网用户不一定都配了 ssh key。改成
http 优先,ssh 备选。同时补一句消费方需要 tsx/ts-node —— 仓库 ship .ts
源,装完就能 import 但 node 直接跑会炸。

下一步打 v0.1.0 tag 让这条指令真能用。
This commit is contained in:
2026-05-23 16:21:54 +08:00
parent 21a56a7b2d
commit 40f311796b
+6
View File
@@ -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"
// ↓ 详见下面"想做什么"指南