Skip to content

Commit ead6b62

Browse files
committed
Updating readme
1 parent ca513d7 commit ead6b62

File tree

1 file changed

+56
-26
lines changed

1 file changed

+56
-26
lines changed

README.md

+56-26
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
# Ocean Protocol VSCode Extension
22

3-
This VSCode extension enables you to execute compute-to-data jobs using Ocean Protocol directly from your development environment. The extension automatically detects your active algorithm file and streamlines job submission, monitoring, and results retrieval.
3+
Run compute jobs on Ocean Protocol directly from VS Code. The extension automatically detects your active algorithm file and streamlines job submission, monitoring, and results retrieval. Simply open a python or javascript file and click **Start Compute Job**.
44

55
## Features
66

7-
- **Compute-to-Data**: Run secure compute jobs without downloading raw data.
8-
- **Active File Detection**: Automatically uses your open JavaScript (.js) or Python (.py) file as the compute algorithm.
9-
- **Dataset & Results Integration**: Optionally select a dataset file and specify a results folder.
10-
- **Job Monitoring**: View job status and algorithm logs in the output panel while results are automatically opened upon job completion.
7+
### 🚀 One-Click Compute Jobs
118

12-
## Prerequisites
9+
Select your algorithm, choose a dataset, and run compute jobs with a single click.
1310

14-
- Node.js (version specified in `.nvmrc`)
15-
- VSCode version 1.93.0 or higher
16-
- Git
11+
### 📊 Real-Time Monitoring
1712

18-
## Running the Extension Locally
13+
Track job progress and view algorithm logs directly in VS Code.
1914

20-
1. Clone the repository:
21-
```bash
22-
git clone https://github.com/your-username/ocean-protocol-vscode
23-
cd ocean-protocol-vscode
24-
```
25-
2. Install dependencies:
26-
```bash
27-
npm install
28-
```
29-
3. Build the extension:
30-
```bash
31-
npm run compile
32-
```
33-
4. Open in VSCode:
34-
- Press F5 to start debugging. This will open a new VSCode window with the extension loaded.
15+
### 📁 Automatic Results Handling
16+
17+
Results are automatically saved and opened when your job completes.
3518

36-
## Usage
19+
## Getting Started
20+
21+
1. Install the extension from the VS Code Marketplace
22+
2. Open the Ocean Protocol panel from the activity bar
23+
3. Configure your compute settings:
24+
- Node URL (pre-filled with default Ocean compute node)
25+
- Optional private key for your wallet
26+
4. Select your files:
27+
- Algorithm file (JS or Python)
28+
- Optional dataset file (JSON)
29+
- Results folder location
30+
5. Click **Start Compute Job**
31+
6. Monitor the job status and logs in the output panel
32+
7. Once completed, the results file will automatically open in VSCode
33+
34+
### Requirements
35+
36+
VS Code 1.96.0 or higher
3737

3838
### Extension Layout
3939

@@ -58,6 +58,36 @@ The extension adds a dedicated Ocean Protocol section to the activity bar. Here
5858

5959
Refer to the project structure and available scripts for local development. Contributions are always welcome—please check our guidelines in the repository.
6060

61+
### Prerequisites
62+
63+
- Node.js (version specified in `.nvmrc`)
64+
- VSCode version 1.93.0 or higher
65+
- Git
66+
67+
### Running the Extension Locally
68+
69+
1. Clone the repository:
70+
71+
```bash
72+
git clone https://github.com/your-username/ocean-protocol-vscode
73+
cd ocean-protocol-vscode
74+
```
75+
76+
2. Install dependencies:
77+
78+
```bash
79+
npm install
80+
```
81+
82+
3. Build the extension:
83+
84+
```bash
85+
npm run compile
86+
```
87+
88+
4. Open in VSCode:
89+
- Press F5 to start debugging. This will open a new VSCode window with the extension loaded.
90+
6191
## License
6292

6393
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)