Skip to content

Commit c5f854a

Browse files
author
Tim Etchells
committed
update readme, changelog
1 parent 6adb81a commit c5f854a

File tree

3 files changed

+55
-63
lines changed

3 files changed

+55
-63
lines changed

CHANGELOG.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
1-
### 19.3 (latest)
2-
- Update for compatibility with Microclimate 19.03 - see [8160b73b](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/commit/8160b73b77065df1b6d1ef80c51f319a71458aa2)
1+
# 0.1.0
32

4-
### 19.2
5-
- Minor bug fix: [#17](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/17)
6-
- Debug port is now only exposed to localhost
7-
8-
### 19.1.1
9-
- Fix Windows-only bugs: [#24](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/24), [#25](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/25)
10-
11-
### 19.1
12-
- Bug fixes: [#8](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/8), [#9](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/9), [#10](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/10), [#12](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/12), [#15](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/15)
13-
- Enhancements: [#2](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/2), [#7](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/7), [#11](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues/11)
14-
15-
### 18.12
16-
Initial release!
17-
18-
#### Release builds are available [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/microclimate/vscode-tools/release/).
3+
Initial alpha preview

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,46 @@
1-
<a href="https://microclimate-dev2ops.github.io/">
1+
<!--a href="https://microclimate-dev2ops.github.io/">
22
<img src="mc-banner.png" alt="Microclimate Banner" height="75px" />
3-
</a>
3+
</a-->
44

5-
# Microclimate Developer Tools for VS Code
5+
# Codewind for VS Code
66

7-
[![Marketplace](https://img.shields.io/vscode-marketplace/v/IBM.microclimate-tools.svg?label=marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=IBM.microclimate-tools)
8-
[![Build Status](https://img.shields.io/travis/com/microclimate-dev2ops/microclimate-vscode-tools/master.svg?logo=travis&label=build)](https://travis-ci.com/microclimate-dev2ops/microclimate-vscode-tools)
7+
[![Marketplace](https://img.shields.io/vscode-marketplace/v/IBM.codewind.svg?label=marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=IBM.codewind)
8+
[![Build Status](https://img.shields.io/travis/com/microclimate-dev2ops/codewind-vscode/master.svg?logo=travis&label=build)](https://travis-ci.com/microclimate-dev2ops/codewind-vscode)
99
[![License](https://img.shields.io/badge/License-EPL%202.0-red.svg?label=license&logo=eclipse)](https://www.eclipse.org/legal/epl-2.0/)
1010
[![Slack](https://img.shields.io/badge/ibm--cloud--tech-blue.svg?logo=slack&label=slack)](https://slack-invite-ibm-cloud-tech.mybluemix.net/)
1111

12-
- **[Documentation](https://microclimate-dev2ops.github.io/mdt-vsc-overview)**
13-
- **[Changelog](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/CHANGELOG.md)**
14-
- **[Extension README](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/dev/README.md)**
12+
- **[Documentation](https://microclimate.dev/codewindtechpreview)**
13+
- **[Changelog](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/CHANGELOG.md)**
14+
- **[Extension README](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/dev/README.md)**
1515

16-
You can use Microclimate Developer Tools for Visual Studio Code to develop your [Microclimate](https://microclimate-dev2ops.github.io) projects from within VS Code. Use the tools to access Microclimate features in the comfort of your IDE.
16+
Create and develop cloud-native, containerized web applications from VS Code.
1717

18-
## Getting started [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-getting-started)
18+
## Getting started
1919

20-
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [local Microclimate version 18.12 or later](https://microclimate-dev2ops.github.io/installlocally).
21-
2. Install Microclimate Developer Tools for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.microclimate-tools) or by searching for "Microclimate" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
20+
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [Codewind](https://microclimate.dev/codewindtechpreview).
21+
2. Install Codewind for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-tools) or by searching for "Codewind" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
2222

2323
If you want to host or build the extension yourself, see [Contributing](#contributing).
2424

25-
## How to use [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-tutorial)
26-
- Navigate to the **Explorer** view group and open the **Microclimate** view.
27-
- Right-click the background of the Microclimate view to access the **New connection** commands.
28-
- After creating a connection, right-click a connection or project to access the other commands.
29-
- Open the [**Command Palette**](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and type "Microclimate" to see the actions available.
25+
## How to use
26+
- Navigate to the **Explorer** view group and open the **Codewind** view.
27+
- Open the [**Command Palette**](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and type "Codewind" to see the actions available.
3028

31-
## Features [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-commands-overview)
32-
- View all projects in Microclimate, including application and build statuses.
33-
- Debug Microprofile, Spring, and Node.js Microclimate projects.
29+
## Features
30+
- Create new projects from application templates, or import existing docker-ready projects.
31+
- View Codewind projects, including application and build statuses.
32+
- Debug Microprofile, Spring, and Node.js projects in their Docker containers.
3433
- View application and build logs in the VS Code **Output** view.
35-
- View project information similar to the information on the Microclimate **Overview** page.
36-
- Integrate Microclimate validation errors into the VS Code **Problems** view.
37-
- Open a shell session into a Microclimate application container.
34+
- View and edit project deployment information.
35+
- Open a shell session into a Codewind application container.
3836
- Toggle project auto build and manually initiate project builds.
39-
- Scope your VS Code workspace to a Microclimate project or to your `microclimate-workspace`.
4037
- Disable, enable, and delete projects.
4138

4239
## Contributing
43-
We welcome [issues](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/issues) and contributions. For more information, see [CONTRIBUTING.md](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/tree/master/CONTRIBUTING.md).
40+
We welcome [issues](https://github.com/microclimate-dev2ops/codewind-vscode/issues) and contributions. For more information, see [CONTRIBUTING.md](https://github.com/microclimate-dev2ops/codewind-vscode/tree/master/CONTRIBUTING.md).
4441

4542
Development builds are available [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/microclimate/vscode-tools/nightly/). Follow the [Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) instructions to install a `.vsix`.
4643

4744
To host the extension yourself so you can develop or debug it, clone this repository and run the **Extension** launch in `dev/.vscode/launch.json`. See [Developing Extensions](https://code.visualstudio.com/docs/extensions/developing-extensions) for more information.
4845

49-
You can also build the extension `.vsix` yourself by running [`vsce package`](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions) from `dev/`. Refer to the `before_install` and `script` sections of [`.travis.yml`](https://github.com/microclimate-dev2ops/microclimate-vscode-tools/blob/master/.travis.yml) to see the exact steps the build runs.
46+
You can also build the extension `.vsix` yourself by running [`vsce package`](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions) from `dev/`. Refer to the `before_install` and `script` sections of [`.travis.yml`](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/.travis.yml) to see the exact steps the build runs.

dev/README.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,42 @@
1-
# Microclimate Developer Tools for VS Code
1+
# Codewind for VS Code
22

3-
[![Marketplace](https://img.shields.io/vscode-marketplace/v/IBM.microclimate-tools.svg?label=marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=IBM.microclimate-tools)
4-
[![Build Status](https://img.shields.io/travis/com/microclimate-dev2ops/microclimate-vscode-tools/master.svg?logo=travis&label=build)](https://travis-ci.com/microclimate-dev2ops/microclimate-vscode-tools)
3+
[![Marketplace](https://img.shields.io/vscode-marketplace/v/IBM.codewind.svg?label=marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=IBM.codewind)
4+
[![Build Status](https://img.shields.io/travis/com/microclimate-dev2ops/codewind-vscode/master.svg?logo=travis&label=build)](https://travis-ci.com/microclimate-dev2ops/codewind-vscode)
55
[![License](https://img.shields.io/badge/License-EPL%202.0-red.svg?label=license&logo=eclipse)](https://www.eclipse.org/legal/epl-2.0/)
66
[![Slack](https://img.shields.io/badge/ibm--cloud--tech-blue.svg?logo=slack&label=slack)](https://slack-invite-ibm-cloud-tech.mybluemix.net/)
77

8-
You can use [Microclimate Developer Tools for Visual Studio Code](https://github.com/microclimate-dev2ops/microclimate-vscode-tools) to develop your [Microclimate](https://microclimate-dev2ops.github.io) projects from within VS Code. Use the tools to access Microclimate features in the comfort of your IDE.
8+
- **[Documentation](https://microclimate.dev/codewindtechpreview)**
9+
- **[Changelog](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/CHANGELOG.md)**
10+
- **[Extension README](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/dev/README.md)**
911

10-
Join us [on Slack](https://slack-invite-ibm-cloud-tech.mybluemix.net) if you have any questions.
12+
Create and develop cloud-native, containerized web applications from VS Code.
1113

12-
## How to install [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-getting-started)
14+
## Getting started
1315

14-
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [local Microclimate version 18.12 or later](https://microclimate-dev2ops.github.io/installlocally).
15-
2. Install Microclimate Developer Tools for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.microclimate-tools) or by searching for "Microclimate" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
16+
1. Install [VS Code version 1.27 or later](https://code.visualstudio.com/download) and [Codewind](https://microclimate.dev/codewindtechpreview).
17+
2. Install Codewind for VS Code from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IBM.codewind-tools) or by searching for "Codewind" in the [VS Code Extensions view](https://code.visualstudio.com/docs/editor/extension-gallery#_browse-for-extensions).
1618

17-
## How to use [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-tutorial)
18-
- Navigate to the **Explorer** view group and open the **Microclimate** view.
19-
- Right-click the background of the Microclimate view to access the **New connection** commands.
20-
- After creating a connection, right-click a connection or project to access the other commands.
21-
- Open the [**Command Palette**](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and type "Microclimate" to see the actions available.
19+
If you want to host or build the extension yourself, see [Contributing](#contributing).
2220

23-
## Features [(Documentation)](https://microclimate-dev2ops.github.io/mdt-vsc-commands-overview)
24-
- View all projects in Microclimate, including application and build statuses.
25-
- Debug Microprofile, Spring, and Node.js Microclimate projects.
21+
## How to use
22+
- Navigate to the **Explorer** view group and open the **Codewind** view.
23+
- Open the [**Command Palette**](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and type "Codewind" to see the actions available.
24+
25+
## Features
26+
- Create new projects from application templates, or import existing docker-ready projects.
27+
- View Codewind projects, including application and build statuses.
28+
- Debug Microprofile, Spring, and Node.js projects in their Docker containers.
2629
- View application and build logs in the VS Code **Output** view.
27-
- View project information similar to the information on the Microclimate **Overview** page.
28-
- Integrate Microclimate validation errors into the VS Code **Problems** view.
29-
- Open a shell session into a Microclimate application container.
30+
- View and edit project deployment information.
31+
- Open a shell session into a Codewind application container.
3032
- Toggle project auto build and manually initiate project builds.
31-
- Scope your VS Code workspace to a Microclimate project or to your `microclimate-workspace`.
3233
- Disable, enable, and delete projects.
34+
35+
## Contributing
36+
We welcome [issues](https://github.com/microclimate-dev2ops/codewind-vscode/issues) and contributions. For more information, see [CONTRIBUTING.md](https://github.com/microclimate-dev2ops/codewind-vscode/tree/master/CONTRIBUTING.md).
37+
38+
Development builds are available [here](https://public.dhe.ibm.com/ibmdl/export/pub/software/microclimate/vscode-tools/nightly/). Follow the [Install from a VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) instructions to install a `.vsix`.
39+
40+
To host the extension yourself so you can develop or debug it, clone this repository and run the **Extension** launch in `dev/.vscode/launch.json`. See [Developing Extensions](https://code.visualstudio.com/docs/extensions/developing-extensions) for more information.
41+
42+
You can also build the extension `.vsix` yourself by running [`vsce package`](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#packaging-extensions) from `dev/`. Refer to the `before_install` and `script` sections of [`.travis.yml`](https://github.com/microclimate-dev2ops/codewind-vscode/blob/master/.travis.yml) to see the exact steps the build runs.

0 commit comments

Comments
 (0)