|
1 |
| -# vscode-react-developer-toolkit README |
| 1 | +# VSCode React Developer Toolkit |
2 | 2 |
|
3 |
| -This is the README for your extension "vscode-react-developer-toolkit". After writing up a brief description, we recommend including the following sections. |
| 3 | +VSCode React Developer Toolkit is a powerful extension designed to enhance your React development workflow in Visual Studio Code. This toolkit provides a set of convenient commands to quickly create common React components and patterns, streamlining your development process and boosting productivity. |
4 | 4 |
|
5 | 5 | ## Features
|
6 | 6 |
|
7 |
| -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +The extension offers the following commands, accessible through the Explorer context menu under "React Developer Toolkit": |
8 | 8 |
|
9 |
| -For example if there is an image subfolder under your extension project workspace: |
| 9 | +- **Create React Component**: Quickly scaffold a new React component |
| 10 | +- **Create React Hook**: Generate a custom React hook |
| 11 | +- **Create React HOC**: Set up a Higher-Order Component |
| 12 | +- **Create React Context**: Create a new React Context |
| 13 | +- **Create React Provider**: Generate a React Provider component |
10 | 14 |
|
11 |
| -\!\[feature X\]\(images/feature-x.png\) |
| 15 | +## Installation |
12 | 16 |
|
13 |
| -> 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. |
| 17 | +1. Open Visual Studio Code |
| 18 | +2. Go to the Extensions view (Ctrl+Shift+X) |
| 19 | +3. Search for "VSCode React Developer Toolkit" |
| 20 | +4. Click Install |
14 | 21 |
|
15 |
| -## Requirements |
| 22 | +## Usage |
16 | 23 |
|
17 |
| -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 24 | +To use the React Developer Toolkit: |
18 | 25 |
|
19 |
| -## Extension Settings |
| 26 | +1. Right-click on a folder in the Explorer view |
| 27 | +2. Navigate to the "React Developer Toolkit" submenu |
| 28 | +3. Select the desired command to create the corresponding React element |
20 | 29 |
|
21 |
| -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 30 | +## Requirements |
22 | 31 |
|
23 |
| -For example: |
| 32 | +- Visual Studio Code version 1.94.0 or higher |
24 | 33 |
|
25 |
| -This extension contributes the following settings: |
| 34 | +## Extension Settings |
26 | 35 |
|
27 |
| -* `myExtension.enable`: Enable/disable this extension. |
28 |
| -* `myExtension.thing`: Set to `blah` to do something. |
| 36 | +This extension doesn't add any VS Code settings. |
29 | 37 |
|
30 | 38 | ## Known Issues
|
31 | 39 |
|
32 |
| -Calling out known issues can help limit users opening duplicate issues against your extension. |
33 |
| - |
34 |
| -## Release Notes |
35 |
| - |
36 |
| -Users appreciate release notes as you update your extension. |
37 |
| - |
38 |
| -### 1.0.0 |
39 |
| - |
40 |
| -Initial release of ... |
41 |
| - |
42 |
| -### 1.0.1 |
43 |
| - |
44 |
| -Fixed issue #. |
45 |
| - |
46 |
| -### 1.1.0 |
47 |
| - |
48 |
| -Added features X, Y, and Z. |
49 |
| - |
50 |
| ---- |
51 |
| - |
52 |
| -## Following extension guidelines |
53 |
| - |
54 |
| -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
55 |
| - |
56 |
| -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
57 |
| - |
58 |
| -## Working with Markdown |
59 |
| - |
60 |
| -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
| 40 | +There are currently no known issues. If you encounter any problems, please report them on the GitHub repository. |
61 | 41 |
|
62 |
| -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
63 |
| -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
64 |
| -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
| 42 | +## Contributing |
65 | 43 |
|
66 |
| -## For more information |
| 44 | +Contributions are welcome! Please feel free to submit a Pull Request. |
67 | 45 |
|
68 |
| -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
69 |
| -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 46 | +## License |
70 | 47 |
|
71 |
| -**Enjoy!** |
| 48 | +This extension is licensed under the [MIT License](LICENSE.md). |
0 commit comments