Skip to content

Commit fd58916

Browse files
author
Agus Makmun
committed
fix: update readme
1 parent 6ba06ae commit fd58916

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A VS Code extension that provides quick terminal access from the sidebar with a
1616

1717
### From VSIX Package
1818

19-
1. Download the latest `.vsix` file from releases
19+
1. Download the latest `.vsix` file from [releases](https://github.com/agusmakmun/vscode-sidebar-terminal/releases)
2020
2. In VS Code, go to Extensions (`Ctrl+Shift+X` / `Cmd+Shift+X`)
2121
3. Click the "..." menu → "Install from VSIX..."
2222
4. Select the downloaded `.vsix` file
@@ -112,16 +112,19 @@ Before publishing, ensure:
112112

113113
1. **Look for the Sidebar Terminal icon** in the activity bar (left sidebar)
114114
2. **Click the icon** to open the terminal sidebar view
115-
3. **Click "📟 Open Terminal"** to open a terminal in the bottom panel
115+
3. **Click "Open New Terminal"** to open a terminal in the bottom panel
116116
4. **Use the terminal** as you normally would
117117

118+
**Note**: The sidebar automatically closes after opening the terminal for a clean experience.
119+
118120
### What You'll See
119121

120122
When you click the Sidebar Terminal icon, you'll see:
121-
- 💻 Terminal icon
123+
- 💻 Terminal icon (💻)
122124
- "Terminal" title
123125
- "Click the button below to open a new terminal in the bottom panel"
124-
- 🟣 "Open New Terminal" button (purple color)
126+
- 🟣 "Open New Terminal" button (purple color: rgb(120, 97, 236))
127+
- **Auto-close behavior**: Sidebar closes automatically after opening terminal
125128

126129
### Keyboard Shortcuts
127130

@@ -137,13 +140,23 @@ The extension works alongside VS Code's built-in terminal shortcuts:
137140
```
138141
vscode-sidebar-terminal/
139142
├── src/
140-
│ └── extension.ts # Main extension logic
143+
│ ├── extension.ts # Main extension logic
144+
│ └── test/ # Test files
145+
│ ├── extension.test.ts # Extension tests
146+
│ ├── runTest.ts # Test runner
147+
│ └── suite/
148+
│ └── index.ts # Test suite configuration
141149
├── images/
142150
│ └── terminal-icon.svg # Sidebar icon
151+
├── out/ # Compiled JavaScript files
143152
├── package.json # Extension manifest
144153
├── tsconfig.json # TypeScript configuration
154+
├── eslint.config.mjs # ESLint configuration
145155
├── .vscodeignore # Files excluded from package
146156
├── .gitignore # Git ignore rules
157+
├── CHANGELOG.md # Release notes
158+
├── test-extension.md # Manual testing guide
159+
├── LICENSE # MIT License
147160
└── README.md # This file
148161
```
149162

@@ -169,9 +182,10 @@ vsce package # Create VSIX package
169182
The extension uses VS Code's **WebviewView API** to create a custom sidebar view that:
170183

171184
1. **Registers a WebviewView provider** for the sidebar
172-
2. **Creates a simple HTML interface** with a terminal button
185+
2. **Creates a simple HTML interface** with a purple "Open New Terminal" button
173186
3. **Handles button clicks** to open terminals in the bottom panel
174-
4. **Integrates with VS Code's native terminal system**
187+
4. **Auto-closes the sidebar** after opening terminal for clean UX
188+
5. **Integrates with VS Code's native terminal system**
175189

176190
## Configuration
177191

@@ -185,7 +199,7 @@ The extension requires no configuration and works out of the box. It integrates
185199

186200
### Extension Not Working
187201

188-
1. **Check activation**: Look for "Sidebar Terminal extension activated!" in Debug Console
202+
1. **Check activation**: Look for "Sidebar Terminal extension is now active!" in Debug Console
189203
2. **Verify installation**: Ensure the extension appears in Extensions list
190204
3. **Restart VS Code**: Sometimes a restart is needed after installation
191205

@@ -222,6 +236,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
222236
- Initial release
223237
- Sidebar terminal interface with clean design
224238
- One-click terminal opening in bottom panel
225-
- Custom purple button styling with hover effects
239+
- Custom purple button styling (rgb(120, 97, 236)) with hover effects
240+
- Auto-close sidebar after opening terminal for clean UX
226241
- No keyboard shortcut conflicts with VS Code built-ins
227-
- Auto-close sidebar after opening terminal
242+
- Comprehensive test suite with 5 passing tests

0 commit comments

Comments
 (0)