tweaks in metadata and improved ReadMe

Author: ngurmen

.gitignore

@@ -1,2 +1,3 @@
 out
-node_modules
+build
+node_modules

LICENSE.md

@@ -1,18 +1,20 @@
 
-Copyright (c) Microsoft Corporation
+Copyright (c) Chainbloq Labs Inc
 
-All rights reserved. 
+All rights reserved.
 
 MIT License
 
-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:
+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 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.
+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.

README.md

@@ -1,21 +1,55 @@
 # VS Code Solidity Comments extension
-Adds NatSpec compliant @notice, @dev, @param and @return tags for function and modifier signatures in Solidity files.
+
+This extension simplifies addition of NatSpec compliant @author, @title, @notice, @dev, @param and @return tags in Solidity files.
 
 ## Installation
-Currently, the solidity-comments VS Code extension is installed from a VSIX file only.
+
+Currently, the solidity-comments VS Code extension is installed from a VSIX file only.  The VSIX file can be downloaded from the [release page](https://github.com/Dexalot/vscode-solidity-comments/releases) on GitHub.
 
 Go to `Extensions` tab and click the `...` at the top.
 
-Select `Install from VSIX`.
+Select `Install from VSIX` and point the file selector dialog to the downloaded VSIX file.
 
 ## Using
-In a Solidity file, move the cursor to a line with a function or modifier signature.
 
-Invoke the `Add Solidity Comments` extension
-- Open the command palette wit `F1` or `ctrl+shift+p` on Windows and find `Add Solidity Comments`. Hit enter.
-- Alternatively, you can use the keybindings `ctrl+alt+d` on Windows and `shift+cmd+d` on Mac.
+* In a Solidity file, move the cursor to a line with a contract, interface, library, function or modifier keywords.
+
+* Invoke the `Add Solidity Comments` extension
+    - Open the command palette wit `F1` or `ctrl+shift+p` on Windows and find `Add Solidity Comments`. Hit enter.
+    - Alternatively, you can use the keybindings `ctrl+alt+d` on Windows and `shift+cmd+d` on Mac.
+
+* The extension will parse the signature on the line of the cursor and add NatSpec doc comments above the line.
+
+    For contract, interface and library keywords the extension adds a header as follows:
+
+    ```
+        /**
+        * @author  .
+        * @title   .
+        * @dev     .
+        * @notice  .
+        */
+    ```
 
-The extension will parse the signature on the line of the cursor. A stub with @notice, @dev, @param and @return tags for each parameter and return variables will be added directly above the line.
+    For function and modifier keywords the extension adds comments as follows:
+
+    ```
+        /**
+        * @notice  .
+        * @dev     .
+        * @param   _address  .
+        * @return  bool  .
+        */
+    ```
 
 ## Limitations
-The extension does not support any other type of NatSpec tags. It only uses @notice, @dev, @param and @return
+
+The extension does not support any other type of NatSpec tags. It only uses @title, @author, @notice, @dev, @param and @return tags.
+
+## Support
+
+Please use the extension at your own risk as is knowing that there is no active support for it.
+
+If you have a feature request or bug report you can open an issue from the [issues page](https://github.com/Dexalot/vscode-solidity-comments/issues) on GitHub.
+
+Please note that there is no promise that these issues will be prioritized among other projects.

build/vscode-solidity-comments-1.0.0.vsix

@@ -11,6 +11,12 @@
   "bugs": {
     "url": "https://github.com/Dexalot/vscode-solidity-comments/issues"
   },
+  "contributors": [
+    {
+      "name" : "M. Nihat Gurmen",
+      "email" : "ngurmen@chainbloq.com"
+    }
+  ],
   "homepage": "https://github.com/Dexalot/vscode-solidity-comments/blob/master/README.md",
   "repository": {
     "type": "git",
@@ -19,10 +25,10 @@
   "categories": [
     "Other"
   ],
-  "version": "1.0.0",
-  "publisher": "dexalot",
+  "version": "1.0.1",
+  "publisher": "chainbloq",
   "engines": {
-    "vscode": "0.10.0"
+    "vscode": "^0.10.0"
   },
   "main": "./out/extension",
   "activationEvents": [
@@ -46,10 +52,10 @@
   "scripts": {
     "vscode:prepublish": "node ./node_modules/vscode/bin/compile",
     "compile": "node ./node_modules/vscode/bin/compile -watch -p ./",
-    "build": "mkdir -p build && vsce package --out build/"
+    "build": "rm -fr build && mkdir build && vsce package --out build/"
   },
   "devDependencies": {
-    "vscode": "0.10.0"
+    "vscode": "^0.10.0"
   },
   "dependencies": {
     "indent-string": "^2.1.0"