Skip to content
This repository has been archived by the owner on Apr 28, 2020. It is now read-only.

Commit

Permalink
Update version with documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aryaminus committed Mar 7, 2018
1 parent a8f1ac4 commit f0f033d
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ All notable changes to the "flowmaker" extension will be documented in this file

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## 1.2.0
- Removed onBrowser with Saving option command within editor

## 1.1.0
- Updated FileSaver to get the SVG

Expand All @@ -13,7 +16,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
- Added tags and dependencies

## 1.0.1
- Update logo and desccription
- Update logo and description

## 0.0.1
- Initial release
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,26 @@ Flowmaker is an VSCode extension used to generate a flowchart in SVG format of `
**Note:**
For only using the onEditor SVG generation follow the <a href="https://github.com/aryaminus/flowmaker/tree/livepreview" target="_blank">livepreview</a> branch code.

For showing in both Browser and Editor follow the <a href="https://github.com/aryaminus/flowmaker/tree/onBrowser" target="_blank">onBrowser</a> branch code.

## Instructions
- Write Javascript.
- Select a function or object or entire file.
- Hit ctrl-f1.
- Choose either 'Flowmake onEditor' or 'Flowmake onBrowser'.
- 'Flowmake onEditor' generates the SVG layout in side column of editor itself.
- 'Flowmake onBrowser' starts a node server on localhost with port 8080 to view and download the SVG code.
- Choose either 'Flowmaker: Preview' or 'Flowmaker: Save'.
- 'Flowmaker: Preview' generates the SVG layout in side column of editor itself.
- 'Flowmaker: Save' allws the user to download the SVG code in the same directory as the file.

## Installation

From [VS Code](https://code.visualstudio.com) Market [Install Flowmaker](https://goo.gl/yRmQNk):
**Install Flowmaker extension:**
```
Launch VS Code Quick Open (Ctrl+P), paste the following command:
ext install speks.flowmaker
```
Then,
```
Install Flowmaker extension
Open any .js file
hit Fn+f1 or F1
choose Flowmake onEditor or Flowmake onBrowser
Expand Down Expand Up @@ -51,15 +58,13 @@ choose Flowmake onEditor or Flowmake onBrowser

[![onEditor demo](https://i.imgur.com/F3LC8LA.png)](https://youtu.be/ySW2ejs6f84)

[![onBrowser demo](https://i.imgur.com/Hw9SZ5M.png)](https://youtu.be/ySW2ejs6f84)

### TODO:
- [ ] JSX support
- [ ] Flow,CLI and Typescript support
- [ ] Chrome extension for dev-tools
- [ ] Fetching SVG to generate and manipulate code to genrate code from flowchart

## Requirements
## Requirements for onBrowser

1. Node server installed
2. Socket.io and express installed ie.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "flowmaker",
"displayName": "flowmaker",
"description": "VS-code extension for live JS code visualization in Flowchart",
"version": "1.1.0",
"version": "1.2.0",
"publisher": "speks",
"engines": {
"vscode": "^1.19.0"
Expand Down

0 comments on commit f0f033d

Please sign in to comment.