Skip to content

Commit 4486ae5

Browse files
Update readme and add screenshots
1 parent 1f065d2 commit 4486ae5

5 files changed

Lines changed: 27 additions & 47 deletions

README.md

Lines changed: 27 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -31,38 +31,30 @@ OctoBrowser is a modern, Chromium-based web browser with GitHub Copilot SDK buil
3131
## Screenshots
3232

3333
### Light Mode
34-
```
35-
+------------------------------------------------------------------+
36-
| OctoBrowser [ - ] [ □ ] [ × ] |
37-
+------------------------------------------------------------------+
38-
| [Tab 1] [Tab 2] [+] |
39-
+------------------------------------------------------------------+
40-
| [←] [→] [↻] | 🔍 https://github.com [🐙] [☀] |
41-
+------------------------------------------------------------------+
42-
| | |
43-
| | 🐙 Copilot |
44-
| Browser Content | [Model: GPT-4.1 ▼] [🗑] |
45-
| | |
46-
| | Welcome to OctoBrowser |
47-
| | |
48-
| | [📄 Summarize] [🔍 Search]|
49-
| | |
50-
| | [Ask Copilot...] [→] |
51-
+------------------------------------------------------------------+
52-
```
34+
![Light Mode](assets/Screenshot%202026-01-23%20222438.png)
35+
36+
### Dark Mode
37+
![Dark Mode](assets/Screenshot%202026-01-23%20222411.png)
38+
39+
### Settings
40+
![Settings](assets/Screenshot%202026-01-23%20222525.png)
41+
42+
### Chat History
43+
![Chat History](assets/Screenshot%202026-01-23%20222547.png)
5344

5445
## Prerequisites
5546

5647
1. **Node.js** (v18 or later)
5748
2. **GitHub Copilot CLI** - Install from [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli)
58-
3. **GitHub Copilot Subscription** - Required for API access
49+
3. ~~**GitHub Copilot Subscription** - Required for API access~~
50+
A Copilot subscription is not required but you are limited to 50 chat requests.
5951

6052
## Installation
6153

6254
```bash
6355
# Clone the repository
64-
git clone https://github.com/yourusername/octobrowser.git
65-
cd octobrowser
56+
git clone https://github.com/HoppouAI/OctoBrowser.git
57+
cd OctoBrowser
6658

6759
# Install dependencies
6860
npm install
@@ -91,7 +83,7 @@ npm run package
9183
- Use keyboard shortcuts: `Ctrl+T` (new tab), `Ctrl+W` (close tab), `Ctrl+L` (focus URL)
9284

9385
### AI Assistant
94-
- Click the Copilot icon in the toolbar to toggle the AI sidebar
86+
- Click the Hamburger menu icon in the toolbar to toggle the AI sidebar (or press ctrl+shift+i)
9587
- Type your question in the chat input
9688
- Click the book icon to include the current page content in your question
9789
- Select different AI models from the dropdown
@@ -100,29 +92,8 @@ npm run package
10092
- "Summarize this page for me"
10193
- "What are the key points in this article?"
10294
- "Search for the latest news about AI"
103-
- "Explain what this code does" (on a GitHub page)
10495
- "Help me find documentation for React hooks"
10596

106-
## Architecture
107-
108-
```
109-
OctoBrowser
110-
├── src/
111-
│ ├── main/ # Electron main process
112-
│ │ ├── main.ts # App entry point
113-
│ │ ├── copilot-service.ts # Copilot SDK integration
114-
│ │ ├── tab-manager.ts # Browser tab management
115-
│ │ └── settings-store.ts # User preferences
116-
│ ├── preload/ # Preload scripts for IPC
117-
│ │ └── preload.ts
118-
│ └── renderer/ # Browser UI
119-
│ ├── index.html
120-
│ ├── styles.css
121-
│ └── app.js
122-
├── assets/ # Icons and images
123-
└── dist/ # Compiled output
124-
```
125-
12697
## Technologies
12798

12899
- **Electron** - Cross-platform desktop framework
@@ -139,6 +110,7 @@ OctoBrowser
139110
| `Ctrl+W` | Close Tab |
140111
| `Ctrl+L` | Focus URL Bar |
141112
| `Ctrl+R` | Reload Page |
113+
| `Ctrl+Shift+I` | Toggle Copilot Sidebar |
142114
| `Enter` | Navigate/Send Message |
143115

144116
## Configuration
@@ -151,20 +123,28 @@ Settings are automatically saved and include:
151123

152124
## Contributing
153125

154-
Contributions are welcome! Please feel free to submit a Pull Request.
126+
~~Contributions are welcome! Please feel free to submit a Pull Request.~~
127+
We will probably archive this after the challenge is over as it was just a temporary fun side project for the competition.
155128

156129
## License
157130

158131
MIT License - See [LICENSE](LICENSE) for details.
159132

160133
## Credits
161134

162-
Built with ❤️ for the GitHub Copilot SDK Weekend Contest
135+
Built with ❤️ for the GitHub Copilot SDK Weekend Contest using Various Models in GitHub Copilot.
136+
Models Used to build this:
137+
- Gemini 3 Pro
138+
- Raptor Mini
139+
- Claude Opus 4.5
140+
and some of our own brain...
163141

142+
## Acknowledgements
164143
- [GitHub Copilot SDK](https://github.com/github/copilot-sdk)
165144
- [Electron](https://www.electronjs.org/)
166145
- [GitHub Primer Design](https://primer.style/)
167-
146+
- [Scroll Bar](https://codepen.io/DevSkyler/pen/QWqOdmp)
147+
- [UBlock Origin Addon](https://github.com/gorhill/uBlock)
168148
---
169149

170150
<p align="center">
70.3 KB
Loading
71.4 KB
Loading
26.2 KB
Loading
28.4 KB
Loading

0 commit comments

Comments
 (0)