From 45539c9e4490e6f4cf88abcfc4dbaa3f7b78b37c Mon Sep 17 00:00:00 2001 From: shmck Date: Sun, 5 Apr 2020 20:57:00 -0700 Subject: [PATCH] post release fixes Signed-off-by: shmck --- README.md | 32 ++++++++++++++++---------------- package-lock.json | 2 +- package.json | 4 ++-- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f7d7d80b..dcba1da7 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,23 @@ CodeRoad is a VSCode extension that allows you to play interactive coding tutori ## Getting Started -### Launch +### Start To start the extension, inside VSCode: -- Open the VSCode command palette. +- Open an empty VSCode workspace (an empty folder) +- Launch the app from the VSCode command palette: - select “View” > “Command Palette” from the top panel - alternatively, press `cmd/ctrl + shift + P` -- Search for and run `CodeRoad:Start` -- A web view should appear on the right side of your editor. Click "Start" +- In the command palette, search for and run `CodeRoad:Start` +- A webview should appear on the right side of your editor. Click "Start" + +### Install + +Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad). + +- You may need to reload the window (`ctrl/cmd + R`) +- See ["Start"](#start) to get started. ### Requirements @@ -25,24 +33,16 @@ To start the extension, inside VSCode: - Node.js 10+ - Git -### Installation - -> Currently CodeRoad is not yet available in the VSCode marketplace (coming soon!). - -To install the extension manually: - -- run `vsce package` to build the package. - Learn more about [VSCE](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) -- run `code —-install-extension coderoad-$VERSION.vsix` where version is the name of the file. -- Reload the window (`ctrl/cmd + R`) -- You should be able to see the extension from the extensions list on the left hand side. Verify that "CodeRoad" is "enabled". - ## Creating Tutorials Build and share your own interactive tutorials. Learn more about [how tutorials area created](./docs/tutorials.md). +## Editing Tutorials + +Tutorials can be edited directly as markdown on Github. + ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/package-lock.json b/package-lock.json index 237f964a..b955cdb0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "coderoad", - "version": "0.1.2", + "version": "0.1.4", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 2f5a9485..b86a9333 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "coderoad", - "version": "0.1.2", + "version": "0.1.4", "description": "Interactive tutorials in your editor", "keywords": [ "tutorial", @@ -75,7 +75,7 @@ }, "displayName": "CodeRoad", "galleryBanner": { - "color": "#C80000", + "color": "#6a67ce", "theme": "dark" }, "preview": true,