Skip to content

Commit

Permalink
Update docs for 0.2.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Martín <[email protected]>
  • Loading branch information
carlosms committed Dec 10, 2018
1 parent 246c228 commit e1f031a
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

A personal project to visualize [Babelfsih Universal Abstract Syntax Trees (UAST)](https://doc.bblf.sh/) from [Visual Studio Code](https://code.visualstudio.com/) using [the webview API](https://code.visualstudio.com/docs/extensions/webview).

![screenshot](./doc/screenshot.png)
![screenshot](./doc/screencast.gif)

## Requirements

Requires [bblfshd](https://github.com/bblfsh/bblfshd) and [bblfsh JSON proxy](https://github.com/carlosms/bblfsh-json-proxy). Both can be run downloading this project's [docker-compose.yml](./docker-compose.yml) and running:

Expand All @@ -16,6 +18,14 @@ Based on:
- https://github.com/rebornix/vscode-webview-react
- https://github.com/bblfsh/uast-viewer

## Install

At this moment the extension is not available in the VS Code Marketplace. You will need to install it manually, following the [official instructions](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix):
- Download the latest `.vsix` file from the [releases page](https://github.com/carlosms/vscode-babelfish/releases).
- Run the `Extensions: Install from VSIX` command in the VS Code Command Palette, and open the downloaded file.

Now you can run the command `Bblfsh: Parse UAST` from the Command Palette.

## Development

Run following commands in the terminal
Expand Down
Binary file added doc/screencast.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/screenshot.png
Binary file not shown.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"type": "git",
"url": "https://github.com/carlosms/vscode-babelfish.git"
},
"version": "0.0.1",
"version": "0.1.0",
"engines": {
"vscode": "^1.23.0"
},
Expand Down

0 comments on commit e1f031a

Please sign in to comment.