Skip to content

Commit cd7505e

Browse files
committed
docs: Update README.md
1 parent aca3217 commit cd7505e

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
<div align="center">
22

3+
![Banner](./assets/banner.png)
4+
35
# Open ChatGPT Atlas
46

57
An Open-Source Browser and Extension that brings the capabilities of ChatGPT Atlas to every browser, allowing you to take actions across 500+ apps and the browser.
68

79
![Atlas Demo](./atlas.gif)
810

9-
[![Chrome Extension](https://img.shields.io/badge/Chrome-Extension-4285F4?logo=GoogleChrome)](https://chrome.google.com/webstore)
10-
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
11-
[![Gemini](https://img.shields.io/badge/Gemini-4285F4?logo=google)](https://ai.google.dev/)
12-
[![Composio](https://img.shields.io/badge/Composio-500%2B%20Tools-FF6B6B)](https://composio.dev)
11+
<a href="https://github.com/composiohq/open-chatgpt-atlas"><img alt="Star" src="https://img.shields.io/badge/⭐%20Star%20Us-GitHub-yellow?style=for-the-badge"></a>
1312

1413

1514
</div>
@@ -52,6 +51,27 @@ npm run build
5251
- Select the `dist` folder
5352
- Open Settings (⚙️ icon) to configure your API keys
5453

54+
### Running the Electron Browser
55+
56+
The project includes a standalone Electron-based browser application with built-in Atlas capabilities.
57+
58+
1. Build the Electron app:
59+
```bash
60+
npm run build:electron
61+
```
62+
63+
2. Start the Electron browser:
64+
```bash
65+
npm run electron
66+
```
67+
68+
3. Or, run in development mode with hot reload:
69+
```bash
70+
npm run electron:dev
71+
```
72+
73+
The Electron browser will launch with the full Atlas functionality integrated, allowing you to use browser tools and tool routing directly from the desktop application.
74+
5575
### Configuration
5676

5777
#### Required Setup

assets/banner.png

529 KB
Loading

0 commit comments

Comments
 (0)