Skip to content

Commit 992011b

Browse files
authored
docs: update README for marketplace release (#331)
1 parent 8909dac commit 992011b

File tree

1 file changed

+119
-14
lines changed

1 file changed

+119
-14
lines changed

README.md

Lines changed: 119 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,131 @@
1-
# Couchbase Explorer (BETA / PREVIEW)
1+
# Couchbase Explorer for Visual Studio
22

3-
A Visual Stuio extension that adds a host of Couchbase & Capella data management and query capabilities right into your IDE!
3+
<p align="center">
4+
<img src="resources/logo.png" alt="Couchbase Explorer Logo" width="128" />
5+
</p>
46

5-
## License
7+
<p align="center">
8+
<strong>Browse, explore, and manage your Couchbase data directly from Visual Studio</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="#features">Features</a> •
13+
<a href="#installation">Installation</a> •
14+
<a href="#getting-started">Getting Started</a> •
15+
<a href="#roadmap">Roadmap</a> •
16+
<a href="#contributing">Contributing</a>
17+
</p>
18+
19+
<p align="center">
20+
<img src="https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge" alt="Marketplace Version" />
21+
<img src="https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge" alt="Marketplace Installations" />
22+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-CouchbaseExplorer?style=for-the-badge" alt="License" />
23+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-CouchbaseExplorer/release_build_and_deploy.yml?style=for-the-badge" alt="Build Status" />
24+
</p>
25+
26+
---
27+
28+
> **Note:** This extension is currently in **BETA / PREVIEW**. We're actively developing new features and would love your feedback!
29+
30+
## Features
31+
32+
Couchbase Explorer brings powerful database management capabilities directly into your Visual Studio workflow:
33+
34+
### Connection Management
35+
- **Multiple Connections** - Save and manage connections to multiple Couchbase Server instances
36+
- **Secure Credential Storage** - Passwords are securely stored using Windows Credential Manager
37+
- **SSL/TLS Support** - Connect securely to your clusters with SSL encryption
38+
- **Connection Testing** - Verify your connection settings before saving
39+
40+
### Data Browsing
41+
- **Hierarchical Tree View** - Navigate your cluster structure: Buckets → Scopes → Collections → Documents
42+
- **Lazy Loading** - Efficient loading of large datasets with batched document retrieval
43+
- **Document Viewer** - View document contents in a formatted JSON editor with syntax highlighting
44+
- **Refresh Support** - Refresh any level of the tree to see the latest data
45+
46+
### Document Operations
47+
- **View Documents** - Double-click or right-click to open documents in a dedicated editor tab
48+
- **Copy JSON** - Quickly copy document contents to clipboard
49+
- **Copy Document ID** - Copy document IDs for use in your code
50+
51+
## Installation
52+
53+
### From Visual Studio Marketplace
54+
55+
1. Open Visual Studio
56+
2. Go to **Extensions****Manage Extensions**
57+
3. Search for "**Couchbase Explorer**"
58+
4. Click **Download** and restart Visual Studio
59+
60+
### From VSIX File
61+
62+
1. Download the latest `.vsix` file from [GitHub Releases](https://github.com/CodingWithCalvin/VS-CouchbaseExplorer/releases)
63+
2. Double-click the file to install
64+
3. Restart Visual Studio
665

7-
[![License - MIT](https://img.shields.io/github/license/CodingWithCalvin/VS-CouchbaseExplorer?style=for-the-badge)](https://img.shields.io/github/license/codingwithcalvin/VS-CouchbaseExplorer?style=for-the-badge)
66+
## Getting Started
867

9-
## Build Status
68+
### Opening Couchbase Explorer
1069

11-
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-CouchbaseExplorer/release_build_and_deploy.yml?style=for-the-badge)
70+
1. Go to **View****Couchbase Explorer**
71+
2. The tool window will appear (by default, docked near Server Explorer)
1272

13-
## Marketplace Status
73+
### Adding a Connection
1474

15-
[![Marketplace Installations](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/i/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge) [![Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/d/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)
16-
[![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/v/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge) [![Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)](https://img.shields.io/visual-studio-marketplace/r/codingwithcalvin.VS-CouchbaseExplorer?style=for-the-badge)
75+
1. Click the **Add Connection** button in the toolbar
76+
2. Enter a friendly name for your connection
77+
3. Enter your Couchbase Server hostname or IP address
78+
4. Provide your username and password
79+
5. Enable SSL/TLS if required
80+
6. Click **Test Connection** to verify
81+
7. Click **Save**
82+
83+
### Browsing Data
84+
85+
1. Right-click your connection and select **Connect**
86+
2. Expand the tree to browse: **Buckets****Scopes****Collections****Documents**
87+
3. Double-click any document to view its contents
88+
89+
## Requirements
90+
91+
- **Visual Studio 2022** or **Visual Studio 2026** (x64 and ARM64 supported)
92+
- **Couchbase Server** 7.0+ or **Couchbase Capella** (Capella support coming soon)
93+
94+
## Roadmap
95+
96+
We're actively working on new features! Here's what's coming:
97+
98+
- [ ] **Couchbase Capella Support** - Connect to cloud-hosted Capella clusters
99+
- [ ] **N1QL Query Editor** - Write and execute N1QL queries
100+
- [ ] **Document Editing** - Create, update, and delete documents
101+
- [ ] **Index Management** - View and manage indexes
102+
- [ ] **Search Integration** - Full-text search capabilities
103+
- [ ] **Import/Export** - Bulk data operations
104+
105+
Have a feature request? [Open an issue](https://github.com/CodingWithCalvin/VS-CouchbaseExplorer/issues/new)!
106+
107+
## Contributing
108+
109+
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - we appreciate all feedback.
110+
111+
### Development Setup
112+
113+
1. Clone the repository
114+
2. Install [Visual Studio 2022 or 2026](https://visualstudio.microsoft.com/) with the **Visual Studio extension development** workload
115+
3. Install the [Extensibility Essentials 2022](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) extension
116+
4. Open `src/CodingWithCalvin.CouchbaseExplorer.sln`
117+
5. Press F5 to launch the experimental instance
118+
119+
## License
17120

18-
## Prerequisite
121+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
19122

20-
In order to use this extension, you must have access to a Couchbase server or hosted Capella database instance.
123+
## Disclaimer
21124

22-
## Contributions
125+
This extension is an independent, community-driven project and is **not affiliated with, endorsed by, or sponsored by Couchbase, Inc.** Couchbase and Capella are trademarks of Couchbase, Inc.
23126

24-
Contributions are welcome! Issues, PRs, etc. This extension is very much in "preview mode", and looking for active feedback and contributors!
127+
---
25128

26-
For cloning and building this project yourself, make sure to install the [Extensibility Essentials 2022 extension](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ExtensibilityEssentials2022) for Visual Studio which enables some features used by this project.
129+
<p align="center">
130+
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
131+
</p>

0 commit comments

Comments
 (0)