Publish VSCode Extension and update README.md

Author: Shellishack

README.md

@@ -1,8 +1,20 @@
 ## About
 Chisel Editor is an editor designed to build and work with AI more naturally on cross-platform devices. 
 
-## Getting Started
+## Getting Started -- User Guide
+### Web Client
+There is a web deployment at https://chisel.claypulse.ai
+### Mobile Client
+Android client is available in release page.
+>Current we only support Android, although it is technically possible to have an iOS build (see developer guide below).
+### Desktop Client
+Linux, MacOS, Windows clients are available in release page.
+>Only Windows is tested in alpha release.
+### VSCode Extension
+A VSCode Webview Extension with limited features is available [here](https://marketplace.visualstudio.com/items?itemName=shellishack.chisel-editor).
 
+
+## Getting Started -- Development Guide
 ### Web Development
 Chisel Editor uses Next.js as the frontend (and backend -- TBD). 
 You can get started with local development by running: 

vscode-extension/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Shellishack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vscode-extension/README.md

@@ -1,71 +1,27 @@
-# Chisel Editor README
+# Chisel Editor
 
-This is the README for your extension "Chisel Editor". After writing up a brief description, we recommend including the following sections.
+Chisel Editor is an editor designed to build and work with AI more naturally on cross-platform devices.
 
 ## Features
 
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+This VSCode Extension has limited features.
+> To use more advanced features on other platforms, try our cross-platform app. https://github.com/Shellishack/chisel-editor
 
-For example if there is an image subfolder under your extension project workspace:
-
-\!\[feature X\]\(images/feature-x.png\)
-
-> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
-
-## Requirements
-
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
 
 ## Extension Settings
-
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
-
-For example:
-
-This extension contributes the following settings:
-
-* `myExtension.enable`: Enable/disable this extension.
-* `myExtension.thing`: Set to `blah` to do something.
+Enter your AI API credentials inside the settings in Chisel Editor.
 
 ## Known Issues
 
-Calling out known issues can help limit users opening duplicate issues against your extension.
+- Voice Chat is disabled in the extension.
+> Voice Chat is available in the standalone builds.
+- Native file management is disabled, this extension relies on VSCode's explorer instead.
 
 ## Release Notes
 
-Users appreciate release notes as you update your extension.
-
-### 1.0.0
-
-Initial release of ...
-
-### 1.0.1
-
-Fixed issue #.
-
-### 1.1.0
-
-Added features X, Y, and Z.
+### v0.0.1-alpha-demo
+An initial tech demo for the event of LLM Agents MOOC Hackathon.
 
 ---
 
-## Following extension guidelines
-
-Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
-
-* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
-
-## Working with Markdown
-
-You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
-
-* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
-* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
-* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
-
-## For more information
-
-* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
-* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
-
 **Enjoy!**

vscode-extension/chisel_logo_round_128_128.png

@@ -1,7 +1,14 @@
 {
   "name": "chisel-editor",
   "displayName": "Chisel Editor",
-  "description": "",
+  "description": "Chisel Editor is an editor designed to build and work with AI more naturally on cross-platform devices.",
+  "icon": "chisel_logo_round_128_128.png",
+  "publisher": "shellishack",
+  "repository": {
+    "directory": "Chisel Editor",
+    "type": "git",
+    "url": "https://github.com/Shellishack/chisel-editor"
+  },
   "version": "0.0.1",
   "engines": {
     "vscode": "^1.95.0"
@@ -73,7 +80,6 @@
       ]
     }
   },
-  
   "scripts": {
     "vscode:prepublish": "npm run package",
     "compile": "webpack",

vscode-extension/examples/test.ts

@@ -27,7 +27,7 @@ export class ChiselEditorProvider implements vscode.CustomTextEditorProvider {
   }
 
   public static readonly viewType = "chisel.editorWebview";
-  private readonly chisel_editor = "http://localhost:3000";
+  private readonly chisel_editor = "https://chisel.claypulse.ai";
 
   constructor(
     private readonly context: vscode.ExtensionContext,

vscode-extension/package.json

@@ -1,7 +1,7 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
 import * as vscode from "vscode";
-import { ChiselEditorProvider } from "./chisel-editor";
+import { ChiselEditorProvider } from "./chisel-editor-provider";
 import { getCurrentEditorUri, getCurrentTabIndex } from "./util";
 
 // This method is called when your extension is activated