|
1 |
| -# php-class-generator README |
| 1 | +# php-class-generator Extension for Visual Studio Code |
2 | 2 |
|
3 |
| -This is the README for your extension "php-class-generator". After writing up a brief description, we recommend including the following sections. |
| 3 | +With this extension, you can quickly generate a skeleton for a PHP class just by running a command. This can save you time when starting a new project or writing code, as you don't have to manually type out the basic structure of a PHP class every time. |
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. |
8 |
| - |
9 |
| -For example if there is an image subfolder under your extension project workspace: |
10 |
| - |
11 |
| -\!\[feature X\]\(images/feature-x.png\) |
12 |
| - |
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. |
| 7 | +- Run `generate-php-class` command from the command palette to generate a skeleton for a PHP class |
14 | 8 |
|
15 | 9 | ## Requirements
|
16 | 10 |
|
17 |
| -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
18 |
| - |
19 |
| -## Extension Settings |
20 |
| - |
21 |
| -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 |
| - |
23 |
| -For example: |
24 |
| - |
25 |
| -This extension contributes the following settings: |
26 |
| - |
27 |
| -* `myExtension.enable`: Enable/disable this extension. |
28 |
| -* `myExtension.thing`: Set to `blah` to do something. |
29 |
| - |
30 |
| -## Known Issues |
31 |
| - |
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. |
| 11 | +- [Visual Studio Code](https://code.visualstudio.com/) |
55 | 12 |
|
56 |
| -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
| 13 | +## Usage |
57 | 14 |
|
58 |
| -## Working with Markdown |
| 15 | +1. Press `Ctrl+Shift+P` to open the command palette |
| 16 | +2. Type `generate-php-class` and press Enter |
| 17 | +3. Enter the name of your class and press Enter |
| 18 | +4. The skeleton for the PHP class will be generated |
59 | 19 |
|
60 |
| -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
| 20 | +## Credits |
61 | 21 |
|
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. |
| 22 | +- [Adrián García](https://github.com/adrigar94) |
65 | 23 |
|
66 |
| -## For more information |
| 24 | +## License |
67 | 25 |
|
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/) |
| 26 | +This extension is licensed under the [MIT License](LICENSE). |
70 | 27 |
|
71 | 28 | **Enjoy!**
|
0 commit comments