diff --git a/CHANGELOG.md b/CHANGELOG.md index 88bb745..0999a6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,4 +6,8 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how ## [Unreleased] -- Initial release +## [0.0.1] - 2024-09-05 + +### Added + +- Basic, complete extension. diff --git a/LICENSE.txt b/LICENSE.txt index 3f3539f..52758a3 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1 +1,21 @@ -My license! \ No newline at end of file +MIT License + +Copyright (c) 2024 Tamir Bahar + +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. \ No newline at end of file diff --git a/README.md b/README.md index 8a09a57..fd3045d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # Function Graph Overview -Show a graph overview for the current function +[Control-flow graph](https://en.wikipedia.org/wiki/Control-flow_graph) visualization for VS Code. + +This extension adds a Graph Overview to VS Code, showing the CFG (control-flow graph) for the current function. + +![Screenshot of the extension](./media/screenshots/banner.png) + +## Supported Languages + +- Go diff --git a/media/screenshots/banner.png b/media/screenshots/banner.png new file mode 100644 index 0000000..2d29c2e Binary files /dev/null and b/media/screenshots/banner.png differ diff --git a/package.json b/package.json index 3488a21..8fe0c02 100644 --- a/package.json +++ b/package.json @@ -51,13 +51,13 @@ "description": "Function Graph Overview", "displayName": "Function Graph Overview", "icon": "./media/icon.png", - "repository": { - "type": "git", - "url": "https://github.com/tmr232/function-graph-overview" - }, "categories": [ "Visualization" ], + "repository": { + "type": "git", + "url": "https://github.com/tmr232/function-graph-overview.git" + }, "preview": true, "activationEvents": [], "contributes": { @@ -87,4 +87,4 @@ "engines": { "vscode": "^1.86.0" } -} +} \ No newline at end of file