Skip to content

Commit 936abf6

Browse files
author
William
committed
update readme and add demo
1 parent a2f7a1d commit 936abf6

File tree

4 files changed

+14
-43
lines changed

4 files changed

+14
-43
lines changed

README.md

+12-42
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,39 @@
11
![logo3](./assets/reactable-logo.png)
2-
![logo2](./assets/rl1.png)
3-
![logo1](./assets/rl2.png)
42
# Reactable Stateless Components
53

64

75
This is the README for your extension "reactable-stateless-components". After writing up a brief description, we recommend including the following sections.
86

97
## Features
108

11-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
9+
Easily create stateless react components, with seperate files for the component, container, a config and styles.
1210

13-
For example if there is an image subfolder under your extension project workspace:
11+
![demo](./assets/demo.gif)
1412

15-
\!\[feature X\]\(images/feature-x.png\)
13+
## Instructions
1614

17-
> 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.
15+
1) Open the command pallet by pushing `cmd p`
1816

19-
## Requirements
20-
21-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
17+
2) type `> Stateless Component`
2218

23-
## Extension Settings
19+
3) Name your component. React Stateless component will then generate the required files for your stateless component
2420

25-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
21+
## Requirements
2622

27-
For example:
23+
VS Code > 1.63.0
2824

29-
This extension contributes the following settings:
25+
## Extension Settings
3026

31-
* `myExtension.enable`: enable/disable this extension
32-
* `myExtension.thing`: set to `blah` to do something
27+
None ar present
3328

3429
## Known Issues
3530

36-
Calling out known issues can help limit users opening duplicate issues against your extension.
31+
Currently only works if your components are in `src/components` directory.
3732

3833
## Release Notes
3934

4035
Users appreciate release notes as you update your extension.
4136

4237
### 1.0.0
4338

44-
Initial release of ...
45-
46-
### 1.0.1
47-
48-
Fixed issue #.
49-
50-
### 1.1.0
51-
52-
Added features X, Y, and Z.
53-
54-
-----------------------------------------------------------------------------------------------------------
55-
56-
## Working with Markdown
57-
58-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
59-
60-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
61-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
62-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
63-
64-
### For more information
65-
66-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
67-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
68-
69-
**Enjoy!**
39+
Initial release of Reactable Stateless Components

assets/demo.gif

1.26 MB
Loading

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "reactable-stateless-components",
33
"displayName": "Reactable Stateless Components",
44
"description": "Easily Create React Stateless Components",
5-
"version": "0.0.1",
5+
"version": "1.0.0",
66
"engines": {
77
"vscode": "^1.63.0"
88
},

src/extension.js

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ const checkForSettingsFile = () => {
4747
// vscode.window.showInformationMessage(
4848
// `Please configure your stateless components`
4949
// );
50+
5051
console.log("no file exists");
5152
const ask = async () => {
5253
const pathToComponents = await vscode.window.showInputBox({

0 commit comments

Comments
 (0)