Skip to content

Commit 13d427c

Browse files
committed
Update readme
1 parent 318a2ca commit 13d427c

File tree

2 files changed

+128
-27
lines changed

2 files changed

+128
-27
lines changed

README.md

Lines changed: 128 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Pulse Editor
55
Pulse Editor is a modular, cross-platform, AI-powered creativity platform with federated app collaboration and extensible workflows.
66

77
> [!IMPORTANT]
8+
> 🎉🎉Pulse Editor is now in beta 2. And we won a hackathon! Read more [here](#major-beta-release-2-we-are-here).
9+
>
810
> Pulse Editor is still in its early development stage. We are trying hard to make sure everything works as expected for all different platforms. See [Beta Release Roadmap](#beta-release-roadmap) below.
911
1012
<p align="center">
@@ -24,16 +26,30 @@ Pulse Editor is a modular, cross-platform, AI-powered creativity platform with f
2426
<span style="font-size: 16px;">
2527

2628
- [Table of Contents](#table-of-contents)
29+
- [Features](#features)
30+
- [Cross-platform full-stack apps collaboration workflow](#cross-platform-full-stack-apps-collaboration-workflow)
31+
- [Remote or local workspace](#remote-or-local-workspace)
32+
- [Start a remote workspace](#start-a-remote-workspace)
33+
- [Create file in workspace](#create-file-in-workspace)
34+
- [Send file to app node](#send-file-to-app-node)
35+
- [Open and interact with workspace terminal](#open-and-interact-with-workspace-terminal)
36+
- [Use Cases](#use-cases)
37+
- [1. Vibe Coding](#1-vibe-coding)
38+
- [Dev Server Live preview](#dev-server-live-preview)
39+
- [Vibe Coding agent -- terminal control](#vibe-coding-agent----terminal-control)
40+
- [Vibe Coding agent -- code modification](#vibe-coding-agent----code-modification)
41+
- [2. Video Editing](#2-video-editing)
42+
- [3. (More to come)](#3-more-to-come)
2743
- [Beta Release Roadmap](#beta-release-roadmap)
2844
- [Major Beta Release 1 (June 2025):](#major-beta-release-1-june-2025)
29-
- [Major Beta Release 2 (planned for 2025 Q3)](#major-beta-release-2-planned-for-2025-q3)
30-
- [Major Beta Release 3 (planned for 2025 Q4)](#major-beta-release-3-planned-for-2025-q4)
45+
- [Major Beta Release 2 (we are here)](#major-beta-release-2-we-are-here)
46+
- [Major Beta Release 3 (planned for 2026 Q1)](#major-beta-release-3-planned-for-2026-q1)
3147
- [Documentation and Guide](#documentation-and-guide)
3248
- [Getting Started -- User Guide](#getting-started----user-guide)
3349
- [Web Client](#web-client)
3450
- [Mobile Client](#mobile-client)
3551
- [Desktop Client](#desktop-client)
36-
- [VSCode Extension](#vscode-extension)
52+
- [VSCode Extension (deprecated)](#vscode-extension-deprecated)
3753
- [Getting Started -- Development Guide](#getting-started----development-guide)
3854
- [Recommended Nodejs version](#recommended-nodejs-version)
3955
- [Install dependencies](#install-dependencies)
@@ -50,9 +66,87 @@ Pulse Editor is a modular, cross-platform, AI-powered creativity platform with f
5066

5167
</span>
5268

69+
# Features
70+
71+
## Cross-platform full-stack apps collaboration workflow
72+
73+
By leveraging [Module Federation](https://module-federation.io/),
74+
Pulse Editor allows federated app collaboration and extensible workflows with AI agents on all platform.
75+
76+
Pulse Editor is not just another drag-and-drop backend automation tool, it is a full-stack automation platform -- a true app OS that unifies both frontend and backend in one visual environment.
77+
78+
<table>
79+
<tr>
80+
<td align="center" width="50%">
81+
<img src="https://cdn.pulse-editor.com/assets/App_Collaboration2.gif" alt="Demo2" width="100%">
82+
<p>Full-stack app node (e.g. <a href="https://github.com/OpenCut-app/OpenCut">OpenCut</a>)</p>
83+
</td>
84+
<td align="center" width="50%">
85+
<img src="https://cdn.pulse-editor.com/assets/App_Collaboration1.gif" alt="Demo1" width="100%">
86+
<p>Full-stack app workflow</p>
87+
</td>
88+
</tr>
89+
</table>
90+
91+
## Remote or local workspace
92+
93+
With Pulse Editor, you can manage your file system within interface.
94+
95+
On desktop, you can choose to open workspace in either local storage or remote container.
96+
97+
On web/mobile, you will
98+
have to start a [remote workspace](#start-a-remote-workspace) first.
99+
100+
### Start a remote workspace
101+
102+
1. Create a new project or select a project <br/>
103+
**Create project:**
104+
![Workspace_CreateProject](https://cdn.pulse-editor.com/assets/Workspace_CreateProject.gif)
105+
**Select project:**
106+
![Workspace_SelectProject](https://cdn.pulse-editor.com/assets/Workspace_SelectProject.gif)
107+
2. Create a new workspace or select a workspace <br/>
108+
**Create workspace:**
109+
![Workspace_CreateWorkspace](https://cdn.pulse-editor.com/assets/Workspace_CreateWorkspace.gif)
110+
**Select workspace:**
111+
![Workspace_CreateWorkspace](https://cdn.pulse-editor.com/assets/Workspace_SelectWorkspace.gif)
112+
113+
### Create file in workspace
114+
115+
![Workspace_CreateFile](https://cdn.pulse-editor.com/assets/Workspace_CreateFile.gif)
116+
117+
### Send file to app node
118+
119+
![Workspace_OpenFile](https://cdn.pulse-editor.com/assets/Workspace_OpenFile.gif)
120+
121+
### Open and interact with workspace terminal
122+
123+
![Workspace_CreateTerminalInWorkspace](https://cdn.pulse-editor.com/assets/Workspace_CreateTerminalInWorkspace.gif)
124+
125+
# Use Cases
126+
127+
## 1. Vibe Coding
128+
129+
Running vibe coding workflow in canvas view allows you to develop software on any device, with help of vibe coding agent.
130+
131+
### Dev Server Live preview
132+
133+
![VibeCoding_LivePrevew](https://cdn.pulse-editor.com/assets/VibeCode_LivePreview.gif)
134+
135+
### Vibe Coding agent -- terminal control
136+
137+
![VibeCoding_TerminalControl](https://cdn.pulse-editor.com/assets/VibeCode_TerminalControlAgent.gif)
138+
139+
### Vibe Coding agent -- code modification
140+
141+
![VibeCoding_CodeEditorControl](https://cdn.pulse-editor.com/assets/VibeCode_CodeEditorControlAgent.gif)
142+
143+
## 2. Video Editing
144+
145+
## 3. (More to come)
146+
53147
# Beta Release Roadmap
54148

55-
🎉🎉Pulse Editor is now in beta.
149+
🎉🎉Pulse Editor is now in beta 2.
56150

57151
We plan to have 2-3 major beta release stages before we reach a stable release version.
58152

@@ -71,21 +165,30 @@ Pulse Editor Marketplace Developer Access is now open for application. If you'd
71165

72166
Even if you haven't got access to publish your extensions to the marketplace, you can still explore Pulse Editor platform by developing your own extensions locally. This is a great opportunity to get an early look at Pulse Editor and start experimenting with its capabilities! See [Extension Development](#pulse-editor-extension-development) below.
73167

74-
### Major Beta Release 2 (planned for 2025 Q3)
168+
### Major Beta Release 2 (we are here)
75169

76-
Planned items:
170+
Pulse Editor beta 2 is now out. Many changes are added in this new release. And, Pulse Editor won a hackathon! Big thanks to AI Hacker House in Shanghai for the hackathon opportunity for me to showcase this project in front of dozens of AI product enthusiasts and entrepreneurs!
77171

78-
- Documentation
79-
- Support for web
80-
- Support remote Pulse Editor instance access
81-
- Extension app AI builder
82-
- ... (WIP)
172+
What's new in this release:
83173

84-
~~Coming Soon: [Making 100 Extension Apps Challenge](https://github.com/shellishack)~~
174+
1. Support frontend and backend module federation to allow developers to publish full-stack apps on Pulse Editor platform.
175+
2. Add workflow canvas to allow collaboration among community full-stack apps.
176+
3. Introduce Pulse Editor cloud platform. With the cloud platform, you can start remote dev container and use it to run automation workflows.
177+
4. Support web editor. Check it out at https://web.pulse-editor.com.
178+
5. Publish mobile app to Google Play (in-progress).
179+
6. Allow users to publish workflows to marketplace.
180+
7. Introduce Pulse Editor platform AI assistants. With the platform AI assistant, you can create productivity workflow effortless via chatting. The platform AI assistant will suggest best fitted apps for you requirements and execute the workflow on your behalf.
181+
8. Updates to npm packages, cli tool, and [Pulse app full-stack React template](https://github.com/claypulse/pulse-app-template).
85182

86-
### Major Beta Release 3 (planned for 2025 Q4)
183+
### Major Beta Release 3 (planned for 2026 Q1)
184+
185+
Planned items:
87186

88-
... (WIP)
187+
- More AI features
188+
- MacOS & Linux & iOS support
189+
- Marketplace payment system (allow extension app developers to monetize)
190+
- More official workflows
191+
- More to be announced!
89192

90193
# Documentation and Guide
91194

@@ -97,8 +200,6 @@ The documentation and user guide will be available at https://docs.pulse-editor.
97200

98201
There is a web deployment at https://web.pulse-editor.com
99202

100-
For detailed web user guide, check out [Web User Guide](web/README.md)
101-
102203
## Mobile Client
103204

104205
Android client is available in release page.
@@ -112,11 +213,11 @@ For detailed mobile user guide, check out [Mobile User Guide](mobile/README.md)
112213
Linux, MacOS, Windows clients are available in release page.
113214

114215
> [!NOTE]
115-
> Only Windows is tested in alpha release.
216+
> Only Windows is tested in beta release.
116217
117218
For detailed desktop user guide, check out [Desktop User Guide](desktop/README.md)
118219

119-
## VSCode Extension
220+
## VSCode Extension (deprecated)
120221

121222
A VSCode Webview Extension with limited features is available [here](https://marketplace.visualstudio.com/items?itemName=shellishack.pulse-editor).
122223

@@ -244,34 +345,42 @@ Some of our official extensions are also open-source. Feel free to take examples
244345
- [Pulse Editor Terminal](https://github.com/ClayPulse/pulse-editor-terminal)
245346

246347
## Pulse Editor NPM libraries development
348+
247349
### Versioning
350+
248351
Use changeset to version each release of npm library.
249352

250353
Enter/Exit prerelease
354+
251355
```bash
252356
npx changeset pre enter alpha
253357
npx changeset pre exit
254358
```
255359

256360
Add a new version
361+
257362
```bash
258363
npx changeset
259364
```
260365

261366
Commit the new version
367+
262368
```bash
263369
npx changeset version
264-
```
370+
```
265371

266372
Publish npm libraries
373+
267374
```bash
268375
# Run build before publishing
269376
npm run shared-utils-build && npm run react-api-build
270377
npx changeset publish
271378
```
272379

273380
For developing main client and using recently modified npm libraries without publishing, you can change web/package.json to have the following:
381+
274382
```json
275383
"@pulse-editor/shared-utils": "../npm-packages/shared-utils",
276384
```
385+
277386
Make sure to change back if using published versions.

web/app/(main-layout)/globals.css

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,6 @@
2424
}
2525
}
2626

27-
@utility text-balance {
28-
text-wrap: balance;
29-
}
30-
31-
@utility view-layout {
32-
@apply bg-default flex h-full w-full flex-col items-start justify-between rounded-2xl p-3;
33-
}
34-
3527
@utility responsive-content {
3628
@apply w-3/4 sm:w-[480px];
3729
}

0 commit comments

Comments
 (0)