Skip to content

Commit

Permalink
feat: edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
khaeransori committed May 17, 2019
1 parent 7f388ee commit db37a87
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 101 deletions.
67 changes: 6 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,10 @@
# json2csv README
# json2csv

This is the README for your extension "json2csv". After writing up a brief description, we recommend including the following sections.
A [Visual Studio Code](https://code.visualstudio.com) extension to convert the current editor selection from JSON to CSV, and vice versa.

## Features
After installation, you'll find two new commands in the [Command Palette](https://code.visualstudio.com/docs/editor/codebasics#_command-palette) (`F1` by default):

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
- Convert JSON to CSV
- Convert CSV to JSON

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> 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.
## 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

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

**Enjoy!**
Uses [json-2-csv](https://github.com/mrodrig/json-2-csv) to do the actual conversion.
40 changes: 0 additions & 40 deletions vsc-extension-quickstart.md

This file was deleted.

0 comments on commit db37a87

Please sign in to comment.