diff --git a/README.md b/README.md index 61ee8be..77e48e3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,33 @@ # vscode-data-preview -VSCode extension for large csv, arrow and parquet data preview with https://github.com/jpmorganchase/perspective +[VSCode](https://github.com/Microsoft/vscode) Data Preview extension for viewing, slicing and dicing large csv, json array, arrow and parquet data files. -## Project Goal +![Alt text](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview.png?raw=true + "Data Preview") -Create a VSCode extension for viewing, slicing and dicing large csv, arrow and parquet data files and produce this Data Preview in VS Code IDE: +# MVP Features -![Alt text](https://github.com/RandomFractals/vscode-data-preview/blob/master/images/vscode-data-preview.png?raw=true - "Data Preview") +- CSV and JSON array data preview, sorting and filtering + +# Next V. + +- Will include large data files support and [Apache Arrow](https://observablehq.com/@randomfractals/apache-arrow) data display and streaming. + +# Dev Log + +See [#DataPreview tag on Twitter](https://twitter.com/hashtag/datapreview?f=tweets&vertical=default&src=hash) for the latest and greatest updates on this vscode extension and what's in store next. + +# Dev Build + +```bash +$ git clone https://github.com/RandomFractals/vscode-data-preview +$ cd vscode-data-preview +$ npm install +$ code . +``` +`F5` to launch Data Preview extension VSCode debug session. + +# Contributions + +Any and all test, code or feedback contributions are welcome. + +Open an issue or create a pull request to make Vega Viewer work better for all. \ No newline at end of file