Skip to content

Commit 993bd2e

Browse files
committed
Add npm installation instructions to README files
1 parent 2b37fb6 commit 993bd2e

2 files changed

Lines changed: 28 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,20 @@ _Creating high-performance, scalable 3D map visualization solutions using WebGL
6767

6868
### 🛠️ Installation
6969

70+
There are two ways to install flywave.gl:
71+
72+
#### Direct npm Installation (Recommended for projects)
73+
74+
```bash
75+
# Using npm
76+
npm install @flywave/flywave.gl
77+
78+
# Using pnpm (recommended)
79+
pnpm add @flywave/flywave.gl
80+
```
81+
82+
#### From Source (For development)
83+
7084
```bash
7185
# Clone repository
7286
git clone https://github.com/flywave/flywave.gl.git
@@ -82,10 +96,6 @@ pnpm start
8296

8397
### 📦 Building for Production
8498

85-
```bash
86-
# Build project for production
87-
pnpm build
88-
```
8999

90100
<br>
91101

README.zh.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,20 @@ _使用 WebGL 和 Three.js 创建高性能、可扩展的 3D 地图可视化解
6767

6868
### 🛠️ 安装步骤
6969

70+
有两种方式安装 flywave.gl:
71+
72+
#### 直接使用 npm 安装(推荐用于项目)
73+
74+
```bash
75+
# 使用 npm
76+
npm install @flywave/flywave.gl
77+
78+
# 使用 pnpm(推荐)
79+
pnpm add @flywave/flywave.gl
80+
```
81+
82+
#### 从源码安装(用于开发)
83+
7084
```bash
7185
# 克隆仓库
7286
git clone https://github.com/flywave/flywave.gl.git
@@ -82,10 +96,6 @@ pnpm start
8296

8397
### 📦 生产环境构建
8498

85-
```bash
86-
# 生产环境构建项目
87-
pnpm build
88-
```
8999

90100
<br>
91101

0 commit comments

Comments
 (0)