From f0f033d9d5b4d52b7af21c98448937ea9ac10931 Mon Sep 17 00:00:00 2001 From: Sunim Acharya Date: Wed, 7 Mar 2018 13:03:32 +0545 Subject: [PATCH] Update version with documentation --- CHANGELOG.md | 5 ++++- README.md | 19 ++++++++++++------- package.json | 2 +- 3 files changed, 17 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5818227..dc79ef1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index 70a7afa..2dfbfe9 100644 --- a/README.md +++ b/README.md @@ -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 livepreview branch code. +For showing in both Browser and Editor follow the onBrowser 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 @@ -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. diff --git a/package.json b/package.json index 26d8859..b93b2e9 100644 --- a/package.json +++ b/package.json @@ -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"