Skip to content

Commit d12611a

Browse files
author
Eli
authored
docs: rewrite README (en/zh/ja/ko) and remove Windows beta guide (#1040)
* docs: rewrite README (en/zh/ja/ko) and remove Windows beta guide * docs: fix dead link to removed windows-beta guide
1 parent a138514 commit d12611a

7 files changed

Lines changed: 62 additions & 170 deletions

File tree

README.ja.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h1 align="center">nexu</h1>
66

77
<p align="center">
8-
<strong>最もシンプルなオープンソース OpenClaw 🦞 デスクトップクライアント — WeChat &amp; Feishu 対応</strong>
8+
<strong>AI Agent を WeChat、Feishu、Slack などの IM で直接動かせるオープンソースのデスクトップクライアント</strong>
99
</p>
1010

1111
<p align="center">
@@ -30,9 +30,7 @@
3030

3131
> 🦞 **WeChat × OpenClaw を最もスムーズに接続**:スキャンして即接続、すぐ使える。
3232
>
33-
> 🖥 **対応プラットフォーム**:macOS(Apple Silicon)· macOS(Intel)· Windows — [ダウンロード](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf)
34-
>
35-
> 🎉 **ベータ特典**:ベータ期間中、Gemini などのトップモデルが **無料** でご利用いただけます。[今すぐダウンロード →](https://nexu.io)
33+
> 🖥 **対応プラットフォーム**:macOS(Apple Silicon)· macOS(Intel)· Windows — [ダウンロード](https://nexu.io)
3634
3735
---
3836

@@ -129,7 +127,7 @@ nexu は **ワンパーソンカンパニー** と小規模チーム向け —
129127

130128
> *「クライアントが Feishu で 40 ページの契約書を送ってくる。Agent に転送する — 10 分後にはリスク要約、要注意条項、修正案の提案が届く。半日かかっていたのが、コーヒーブレイクで済む。」*
131129
132-
契約レビュー、規制調査、レポート作成、クライアント Q&amp;A — ドメイン知識を Agent のスキルに変換。
130+
契約レビュー、規制調査、レポート作成、クライアント Q&A — ドメイン知識を Agent のスキルに変換。
133131

134132
### 🏪 地域ビジネス / 小売
135133

@@ -155,13 +153,11 @@ nexu は **ワンパーソンカンパニー** と小規模チーム向け —
155153

156154
### インストール
157155

158-
**ビルド済みクライアント(推奨)**
159-
160156
| プラットフォーム | ダウンロード |
161157
|------------------|-------------|
162-
| 🍎 macOS(Apple Silicon) | [公式サイト](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
163-
| 🍎 macOS(Intel) | [ダウンロード](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
164-
| 🪟 Windows | [ダウンロード](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
158+
| 🍎 macOS(Apple Silicon) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
159+
| 🍎 macOS(Intel) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
160+
| 🪟 Windows | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
165161

166162
### 初回起動
167163

@@ -181,7 +177,6 @@ nexu アカウントでサインインすれば対応モデルにすぐアクセ
181177
```text
182178
nexu/
183179
├── apps/
184-
│ ├── api/ # Backend API
185180
│ ├── web/ # Web frontend
186181
│ ├── desktop/ # Desktop client (Electron)
187182
│ └── controller/ # Controller service
@@ -194,18 +189,18 @@ nexu/
194189
### コマンド
195190

196191
```bash
197-
pnpm run dev # Dev stack with hot reload
198-
pnpm run dev:desktop # Desktop client
199-
pnpm run build # Production build
200-
pnpm run lint
192+
pnpm dev start # フル開発スタック起動(ホットリロード)
193+
pnpm dev stop # 開発スタック停止
194+
pnpm build # プロダクションビルド
195+
pnpm lint
201196
pnpm test
202197
```
203198

204199
---
205200

206201
## 🤝 コントリビュート
207202

208-
コントリビュート歓迎!英語の完全ガイドはリポジトリルートの [CONTRIBUTING.md](CONTRIBUTING.md) にあります(PR 作成時に GitHub が表示します)。同じ内容が [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing) にも掲載されています。**中文:** [docs.nexu.io (zh)](https://docs.nexu.io/zh/guide/contributing) · [docs/zh/guide/contributing.md](docs/zh/guide/contributing.md)
203+
コントリビュート歓迎!詳細ガイドはリポジトリルートの [CONTRIBUTING.md](CONTRIBUTING.md)、または [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing) をご覧ください
209204

210205
1. 🍴 このリポジトリをフォーク
211206
2. 🌿 フィーチャーブランチを作成(`git checkout -b feature/amazing-feature`
@@ -250,9 +245,9 @@ A: WeChat 8.0.7 の OpenClaw プラグインに対応しています。接続を
250245

251246
| チャンネル | 用途 |
252247
|---------|-------------|
253-
| 💡 [**Discussions**](https://github.com/nexu-io/nexu/discussions) | 質問、アイデアの提案、ユースケースの共有など。**Q&amp;A** カテゴリでトラブルシューティング、**Ideas** で機能ブレスト。 |
248+
| 💡 [**Discussions**](https://github.com/nexu-io/nexu/discussions) | 質問、アイデアの提案、ユースケースの共有など。**Q&A** カテゴリでトラブルシューティング、**Ideas** で機能ブレスト。 |
254249
| 🐛 [**Issues**](https://github.com/nexu-io/nexu/issues) | バグ報告や機能リクエスト。Issue テンプレートをご利用ください。 |
255-
| 📋 [**Roadmap &amp; RFCs**](https://github.com/nexu-io/nexu/discussions/categories/rfc-roadmap) | 今後の計画をフォローし、設計ディスカッションに参加。 |
250+
| 📋 [**Roadmap & RFCs**](https://github.com/nexu-io/nexu/discussions/categories/rfc-roadmap) | 今後の計画をフォローし、設計ディスカッションに参加。 |
256251
| 📧 [**support@nexu.ai**](mailto:support@nexu.ai) | プライベートなお問い合わせ、パートナーシップなど。 |
257252

258253
### コミュニティグループに参加する

README.ko.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h1 align="center">nexu</h1>
66

77
<p align="center">
8-
<strong>가장 간단한 오픈소스 OpenClaw 🦞 데스크톱 클라이언트 — WeChat &amp; Feishu 지원</strong>
8+
<strong>AI Agent를 WeChat, Feishu, Slack 등의 IM에서 직접 실행하는 오픈소스 데스크톱 클라이언트</strong>
99
</p>
1010

1111
<p align="center">
@@ -30,9 +30,7 @@
3030

3131
> 🦞 **WeChat × OpenClaw을 가장 매끄럽게 연결**: 스캔하고 바로 연결, 즉시 사용 가능.
3232
>
33-
> 🖥 **지원 플랫폼**: macOS (Apple Silicon) · macOS (Intel) · Windows — [다운로드](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf)
34-
>
35-
> 🎉 **베타 혜택**: 베타 기간 동안 Gemini 등 최상위 모델을 **무료로** 사용할 수 있습니다. [지금 다운로드 →](https://nexu.io)
33+
> 🖥 **지원 플랫폼**: macOS (Apple Silicon) · macOS (Intel) · Windows — [다운로드](https://nexu.io)
3634
3735
---
3836

@@ -155,13 +153,11 @@ nexu는 **1인 기업**과 소규모 팀을 위해 만들어졌습니다 — 한
155153

156154
### 설치
157155

158-
**빌드된 클라이언트 (권장)**
159-
160156
| 플랫폼 | 다운로드 |
161157
|--------|----------|
162-
| 🍎 macOS (Apple Silicon) | [공식 사이트](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
163-
| 🍎 macOS (Intel) | [다운로드](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
164-
| 🪟 Windows | [다운로드](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
158+
| 🍎 macOS (Apple Silicon) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
159+
| 🍎 macOS (Intel) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
160+
| 🪟 Windows | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
165161

166162
### 첫 실행
167163

@@ -181,7 +177,6 @@ nexu 계정으로 로그인하면 지원 모델에 즉시 액세스할 수 있
181177
```text
182178
nexu/
183179
├── apps/
184-
│ ├── api/ # Backend API
185180
│ ├── web/ # Web frontend
186181
│ ├── desktop/ # Desktop client (Electron)
187182
│ └── controller/ # Controller service
@@ -194,18 +189,18 @@ nexu/
194189
### 명령어
195190

196191
```bash
197-
pnpm run dev # Dev stack with hot reload
198-
pnpm run dev:desktop # Desktop client
199-
pnpm run build # Production build
200-
pnpm run lint
192+
pnpm dev start # 전체 로컬 스택 시작 (핫 리로드)
193+
pnpm dev stop # 로컬 스택 중지
194+
pnpm build # 프로덕션 빌드
195+
pnpm lint
201196
pnpm test
202197
```
203198

204199
---
205200

206201
## 🤝 기여하기
207202

208-
기여를 환영합니다! 영문 전체 가이드는 저장소 루트의 [CONTRIBUTING.md](CONTRIBUTING.md)에 있습니다 (PR 작성 시 GitHub에 표시됨). 동일한 내용이 [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing)에도 게시되어 있습니다. **중문:** [docs.nexu.io (zh)](https://docs.nexu.io/zh/guide/contributing) · [docs/zh/guide/contributing.md](docs/zh/guide/contributing.md).
203+
기여를 환영합니다! 자세한 가이드는 저장소 루트의 [CONTRIBUTING.md](CONTRIBUTING.md) 또는 [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing)을 참고하세요.
209204

210205
1. 🍴 이 저장소를 포크
211206
2. 🌿 기능 브랜치 생성 (`git checkout -b feature/amazing-feature`)

README.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h1 align="center">nexu</h1>
66

77
<p align="center">
8-
<strong>The simplest open-source OpenClaw 🦞 desktop client for WeChat & Feishu</strong>
8+
<strong>The open-source desktop client that connects your AI Agent to WeChat, Feishu, Slack & more</strong>
99
</p>
1010

1111
<p align="center">
@@ -30,9 +30,7 @@
3030

3131
> 🦞 **The smoothest way to connect OpenClaw to WeChat**: Scan, connect, and go.
3232
>
33-
> 🖥 **Supported platforms**: macOS (Apple Silicon) · macOS (Intel) · Windows — [Downloads](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf)
34-
>
35-
> 🎉 **Beta Perk**: During the beta period, top-tier models like Gemini and more are **free to use**. [Download and try now →](https://nexu.io)
33+
> 🖥 **Supported platforms**: macOS (Apple Silicon) · macOS (Intel) · Windows — [Download](https://nexu.io)
3634
3735
---
3836

@@ -87,15 +85,15 @@ Use Gemini and more directly via your nexu account. No extra config. Switch to y
8785

8886
### 🔐 OAuth login, no key needed
8987

90-
MiniMax, OpenAI Codex, and GLM (Z.AI Coding Plan) support OAuth loginauthorize with one click, no need to copy-paste API keys.
88+
MiniMax, OpenAI Codex, and GLM (Z.AI Coding Plan) support OAuth loginauthorize with one click, no need to copy-paste API keys.
9189

9290
### 🔑 Bring your own API Key, no login
9391

9492
Prefer your own model providers? Add your API Key and use the client without creating an account or logging in.
9593

9694
### 📱 IM-connected, mobile-ready
9795

98-
Connect to WeChat, Feishu, Slack, or Discord and your AI agent is instantly available on your phone. No extra appjust open WeChat or your team chat and start talking to your agent on the go.
96+
Connect to WeChat, Feishu, Slack, or Discord and your AI agent is instantly available on your phone. No extra appjust open WeChat or your team chat and start talking to your agent on the go.
9997

10098
### 👥 Built for teams
10199

@@ -105,43 +103,43 @@ Open-source at the core, with a desktop experience that actually runs. Compatibl
105103

106104
## Use cases
107105

108-
nexu is built for **One Person Company** and small teamsone person, one AI team.
106+
nexu is built for **One Person Company** and small teamsone person, one AI team.
109107

110108
### 🛒 Solo e-commerce / cross-border trade
111109

112110
> *"I used to spend the whole weekend writing listings in 3 languages. Now I tell my Agent the product specs in Feishu, and by the time I finish my coffee, the listings are ready for Amazon, Shopee, and TikTok Shop."*
113111
114-
Product research, competitor pricing, listing optimization, multilingual marketing assetscompress a week's work into one afternoon.
112+
Product research, competitor pricing, listing optimization, multilingual marketing assetscompress a week's work into one afternoon.
115113

116114
### ✍️ Content creators / knowledge bloggers
117115

118-
> *"Monday morning: I ask my Agent in Slack for this week's trending topics. By lunch, I have 5 draft posts across Xiaohongshu, WeChat, and Twittereach in the right tone for the platform."*
116+
> *"Monday morning: I ask my Agent in Slack for this week's trending topics. By lunch, I have 5 draft posts across Xiaohongshu, WeChat, and Twittereach in the right tone for the platform."*
119117
120-
Trend tracking, topic generation, multi-platform content production, comment engagementrun a content matrix solo.
118+
Trend tracking, topic generation, multi-platform content production, comment engagementrun a content matrix solo.
121119

122120
### 💻 Indie developers
123121

124122
> *"3 AM bug hunt? I paste the stack trace into Discord, my Agent traces it to a race condition, suggests a fix, and even drafts the PR description. Pair programming that never sleeps."*
125123
126-
Code review, doc generation, bug analysis, repetitive task automationyour Agent is your pair-programming partner.
124+
Code review, doc generation, bug analysis, repetitive task automationyour Agent is your pair-programming partner.
127125

128126
### ⚖️ Legal / finance / consulting
129127

130-
> *"A client sends a 40-page contract on Feishu. I forward it to my Agent10 minutes later I get a risk summary, flagged clauses, and suggested revisions. What used to take half a day now takes a coffee break."*
128+
> *"A client sends a 40-page contract on Feishu. I forward it to my Agent10 minutes later I get a risk summary, flagged clauses, and suggested revisions. What used to take half a day now takes a coffee break."*
131129
132-
Contract review, regulation lookup, report generation, client Q&Aturn domain expertise into Agent skills.
130+
Contract review, regulation lookup, report generation, client Q&Aturn domain expertise into Agent skills.
133131

134132
### 🏪 Local business / retail
135133

136134
> *"Customers message me at midnight asking 'is this in stock?' My Agent in Feishu auto-replies with real-time inventory, handles returns, and even sends a promo coupon. I actually sleep now."*
137135
138-
Inventory management, order follow-up, auto-reply to customer messages, marketing copylet AI help run the shop.
136+
Inventory management, order follow-up, auto-reply to customer messages, marketing copylet AI help run the shop.
139137

140138
### 🎨 Design / creative
141139

142-
> *"I drop a rough brief in Slack: 'landing page for a pet food brand, playful vibe.' My Agent comes back with copy options, color palette suggestions, and reference imagesall before the kickoff meeting."*
140+
> *"I drop a rough brief in Slack: 'landing page for a pet food brand, playful vibe.' My Agent comes back with copy options, color palette suggestions, and reference imagesall before the kickoff meeting."*
143141
144-
Requirement breakdown, asset search, copywriting, design annotationfree up creative time, cut repetitive work.
142+
Requirement breakdown, asset search, copywriting, design annotationfree up creative time, cut repetitive work.
145143

146144
---
147145

@@ -155,13 +153,11 @@ Requirement breakdown, asset search, copywriting, design annotation—free up cr
155153

156154
### Installation
157155

158-
**Pre-built client (recommended)**
159-
160156
| Platform | Download |
161157
|----------|----------|
162-
| 🍎 macOS (Apple Silicon) | [Official site](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
163-
| 🍎 macOS (Intel) | [Download](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
164-
| 🪟 Windows | [Download](https://powerformer.feishu.cn/wiki/IWQZwt1qSiExq7kfioWcI1qVnFf) |
158+
| 🍎 macOS (Apple Silicon) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
159+
| 🍎 macOS (Intel) | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
160+
| 🪟 Windows | [nexu.io](https://nexu.io) · [Releases](https://github.com/nexu-io/nexu/releases) |
165161

166162
### First launch
167163

@@ -181,7 +177,6 @@ Sign in with your nexu account for instant access to supported models, or add yo
181177
```
182178
nexu/
183179
├── apps/
184-
│ ├── api/ # Backend API
185180
│ ├── web/ # Web frontend
186181
│ ├── desktop/ # Desktop client (Electron)
187182
│ └── controller/ # Controller service
@@ -194,18 +189,18 @@ nexu/
194189
### Commands
195190

196191
```bash
197-
pnpm run dev # Dev stack with hot reload
198-
pnpm run dev:desktop # Desktop client
199-
pnpm run build # Production build
200-
pnpm run lint
192+
pnpm dev start # Start full local stack with hot reload
193+
pnpm dev stop # Stop local stack
194+
pnpm build # Production build
195+
pnpm lint
201196
pnpm test
202197
```
203198

204199
---
205200

206201
## 🤝 Contributing
207202

208-
Contributions are welcome! The full English guide is [CONTRIBUTING.md](CONTRIBUTING.md) at the repo root (what GitHub shows when you open a PR). The same content is published at [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing).
203+
Contributions are welcome! The full guide is in [CONTRIBUTING.md](CONTRIBUTING.md) at the repo root, and published at [docs.nexu.io — Contributing](https://docs.nexu.io/guide/contributing). **Chinese:** [docs.nexu.io (zh)](https://docs.nexu.io/zh/guide/contributing).
209204

210205
For Chinese-speaking contributors, we recommend starting from these entry points:
211206

@@ -231,10 +226,10 @@ For Chinese-speaking contributors, we recommend starting from these entry points
231226
## ❓ FAQ
232227

233228
**Q: Is nexu free?**
234-
A: The client is completely free and open-source (MIT). Multiple top-tier models are built in for you to use, and you can also bring your own API Key.
229+
A: The client is completely free and open-source (MIT). Multiple top-tier models are built in, and you can also bring your own API Key.
235230

236231
**Q: Which operating systems are supported?**
237-
A: macOS 12+ (Apple Silicon & Intel) and Windows 10+ are supported.
232+
A: macOS 12+ (Apple Silicon & Intel) and Windows 10+.
238233

239234
**Q: Which IM platforms are supported?**
240235
A: WeChat, Feishu, Slack, and Discord are built in and work out of the box.
@@ -256,8 +251,8 @@ We use GitHub as the primary hub for community interaction. Before opening a new
256251

257252
| Channel | When to use |
258253
|---------|-------------|
259-
| 💡 [**Discussions**](https://github.com/nexu-io/nexu/discussions) | Ask questions, propose ideas, share use cases, or just say hi. Browse the **Q&A** category for troubleshooting and **Ideas** for feature brainstorming. |
260-
| 🐛 [**Issues**](https://github.com/nexu-io/nexu/issues) | Report a bug or request a specific feature. Please use the provided issue templates — they help us triage faster. |
254+
| 💡 [**Discussions**](https://github.com/nexu-io/nexu/discussions) | Ask questions, propose ideas, share use cases, or just say hi. Browse **Q&A** for troubleshooting and **Ideas** for feature brainstorming. |
255+
| 🐛 [**Issues**](https://github.com/nexu-io/nexu/issues) | Report a bug or request a specific feature. Please use the provided issue templates. |
261256
| 📋 [**Roadmap & RFCs**](https://github.com/nexu-io/nexu/discussions/categories/rfc-roadmap) | Follow upcoming plans and join design discussions on proposed changes. |
262257
| 📧 [**support@nexu.ai**](mailto:support@nexu.ai) | For private inquiries, partnership, or anything not suited for a public thread. |
263258

0 commit comments

Comments
 (0)