Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathancreamer-eb committed Oct 11, 2018
1 parent b6a5add commit a58c149
Showing 1 changed file with 50 additions and 65 deletions.
115 changes: 50 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,50 @@
# eventbrite-vscode-snippets README

This is the README for your extension "eventbrite-vscode-snippets". After writing up a brief description, we recommend including the following sections.

## Features

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

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!**
# Eventbrite VSCode Snippets
This repository is a collection of snippets for Visual Studio Code

## Snippets
They are located in the `/snippets` directory.

| Snippet | Renders |
| ------- | ------------------------------------- |
| `eb-redux-basic-reducer` | Basic Redux Reducer|
| `eds-basic-component` | Basic EDS Component|

## Full Expansions

### eb-redux-basic-reducer - Basic Redux Reducer

```javascript
function $1(state = {}, {type, payload}) {
switch (type) {
case 'ACTION':
return {
...state,
};
default:
return state;
}
};

export default $1;
```

### eds-basic-component - Basic EDS Component

```javascript
import React, {PureComponent} from 'react';
import PropTypes from 'prop-types';

/**
* Component description
*/
export default class $1 extends PureComponent {
static propTypes = {};

render() {

return (

);
}
}
```

0 comments on commit a58c149

Please sign in to comment.