Merge pull request #11 from PraneshASP/chore/readme

Release `v1.0.0`

Author: PraneshASP

CHANGELOG.md

@@ -4,10 +4,16 @@ All notable changes to the "vscode-solidity-inspector" extension will be documen
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## v.0.0.3
-- Add support for projects with `foundry.toml` and `hardhat.config.ts` config files
-- Add a new feature: `storage-layout` inspector
-- Refactoring of the codebase
+## [v.1.0.0](https://github.com/PraneshASP/vscode-solidity-inspector/releases/tag/v1.0.0)
+- Added a feature to flatten smart contracts.
+- Introduced a feature to highlight unused import statements inline to easily detect them.
+
+## [v.0.0.3](https://github.com/PraneshASP/vscode-solidity-inspector/releases/tag/v0.0.3)
+- Added support for projects with `foundry.toml` and `hardhat.config.ts` config files
+- Introduced a new feature: `storage-layout` inspector
+- Extensive refactoring of the codebase
 
-## v.0.01 - v.0.0.2
-- Initial release
+## [v.0.01 - v.0.0.2](https://github.com/PraneshASP/vscode-solidity-inspector/releases/tag/v0.0.2)
+- Initial release of the extension with basic functionalities
+
+ 

README.md

@@ -1,4 +1,4 @@
-<img align="right" width="150" height="150" top="100" src="./assets/icon.jpg">
+<img align="right" width="150" height="150" top="100" src="./assets/m-icon.jpg">
 
 # VSCode Solidity Inspector • [![license](https://img.shields.io/badge/MIT-brown.svg?label=license)](https://github.com/PraneshASP/vscode-solidity-inspector/blob/main/LICENSE)
 
@@ -19,6 +19,8 @@ TL;DR, this is my first VSCode extension, so feel free to provide feedback as I
 - Forge ir-optimized o/p generation for the current file (or) selected file(s).
 - Forge asm-optimized o/p generation for the current file (or) selected file(s).
 - Forge storage-layout o/p generation for the current file (or) selected file(s).
+- Flatten current file (or) selected file(s).
+- Inline highlighting in code editor for unused imports.
 
 ---
 
@@ -33,31 +35,45 @@ The following will need to be installed in order to use this template. Please fo
 
 ## Usage
 
-The usage of this extension is straightforward. You can inspect the solidity contracts that are under the foundry project in two ways:
+The usage of this extension is straightforward.
 
-### 1.) From the context menu: Select file(s) -> Right click -> `SolidityInspector: ir-inspect selected file(s)`
+### 1.) From the context menu: Select file(s) -> Right click -> `SolidityInspector: <ACTION>`
 
-<img src="./assets/context-menu.gif" />
+<img src="./assets/context-menu.gif"/>
 
 ---
 
-### 2.) From the command pallet: Press `Cmd + Shift + P` -> Search `Solidity Inspector - ir-optimizer`
+### 2.) From the command pallet: Press `Cmd + Shift + P` -> Search `Solidity Inspector - <ACTION>`
 
 #### IR-Optimized Output:
 
-<img  src="./assets/ir-opt.gif" />
+<img  src="./assets/ir-opt.gif"/>
 
 ---
 
 #### ASM-Optimized Output:
 
-<img src="./assets/asm-opt.gif" />
+<img src="./assets/asm-opt.gif"/>
 
 ---
 
 #### Storage layout Output:
 
-<img src="./assets/storage-layout.gif" />
+<img src="./assets/storage-layout.gif"/>
+
+---
+
+#### Flatten contract Output:
+
+<img src="./assets/flatten.gif"/>
+
+
+---
+
+#### Highlights unused imports:
+
+https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/e4906ad3-69e6-4cea-b986-7712ec342fca
+
 
 ---