packaging

Author: Dvir Yitzchaki

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Dvir Yitzchaki
+
+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.

README.md

@@ -1,65 +1,23 @@
-# parquet-viewer README
+# parquet-viewer
 
-This is the README for your extension "parquet-viewer". After writing up a brief description, we recommend including the following sections.
+Views [Apache Parquet](https://parquet.apache.org/) files as JSON.
+
+Requires [parquet-tools](https://github.com/apache/parquet-mr/tree/master/parquet-tools).
 
 ## Features
 
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+When opening a Parquet file and choosing to "open it anyway" a JSON presentation of the file is displayed:
 
-For example if there is an image subfolder under your extension project workspace:
+![automatic](images/automatic.gif)
 
-\!\[feature X\]\(images/feature-x.png\)
+There's also a command to open the JSON presentation:
 
-> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
+![command](images/command.gif)
 
 ## Requirements
 
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
-
-## Extension Settings
-
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
-
-For example:
-
-This extension contributes the following settings:
-
-* `myExtension.enable`: enable/disable this extension
-* `myExtension.thing`: set to `blah` to do something
-
-## Known Issues
-
-Calling out known issues can help limit users opening duplicate issues against your extension.
-
-## Release Notes
-
-Users appreciate release notes as you update your extension.
-
-### 1.0.0
-
-Initial release of ...
-
-### 1.0.1
-
-Fixed issue #.
-
-### 1.1.0
-
-Added features X, Y, and Z.
-
------------------------------------------------------------------------------------------------------------
-
-## Working with Markdown
-
-**Note:** You can author your README using Visual Studio Code.  Here are some useful editor keyboard shortcuts:
-
-* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
-* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
-* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
-
-### For more information
+[parquet-tools](https://github.com/apache/parquet-mr/tree/master/parquet-tools) should be in your PATH.
 
-* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
-* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
+### 0.1.0
 
-**Enjoy!**
+Initial release 

images/automatic.gif

@@ -3,16 +3,36 @@
   "displayName": "parquet-viewer",
   "description": "Views Apache Parquet files as JSON",
   "publisher": "dvirtz",
-  "version": "0.0.1",
+  "icon": "images/ico128.png",
+  "homepage": "https://github.com/dvirtz/vscode-parquet-viewer",
+	"bugs": {
+		"url": "https://github.com/dvirtz/vscode-parquet-viewer/issues",
+		"email": "[email protected]"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dvirtz/vscode-parquet-viewer.git"
+  },
+  "author": {
+    "name": "Dvir Yitzchaki",
+    "email": "[email protected]",
+    "url": "https://github.com/dvirtz"
+  },
+  "license": "SEE LICENSE AT LICENSE.txt",
+  "version": "0.1.0",
   "engines": {
     "vscode": "^1.30.0"
   },
   "categories": [
     "Other"
   ],
+  "keywords": [
+    "parquet",
+    "spark",
+    "viewer"
+  ],
   "activationEvents": [
-    "onLanguage:parquet",
-    "onFileSystem:file"
+    "onLanguage:parquet"
   ],
   "main": "./out/extension",
   "contributes": {