-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from oguzzkilic/fix/readme-file
fix: update README.md file
- Loading branch information
Showing
1 changed file
with
25 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,46 @@ | ||
| # vscode-undoc | ||
| <img src='icon.png' width="200"> | ||
| An documentation generator for JavaScript functions and class methods. It detects undocumented functions and class methods in your Javascript / Flow / React file and creates a documentation template above the function or method. | ||
| <p align="center"><img src='icon.png' width="200"></p> | ||
| <h2 align="center">vscode-undoc</h2> | ||
| <p align="center">An documentation generator for JavaScript functions and class methods. It detects undocumented functions and class methods in your Javascript / Flow / React file and creates a documentation template above the function or method.</p> | ||
|
|
||
| ## Usage | ||
|
|
||
| ##### Using Command Palette (CMD/CTRL + Shift + P) | ||
|
|
||
| `CMD + Shift + P -> Create Docs` | ||
|
|
||
| #### React Example | ||
| ## Install | ||
| [undoc](https://marketplace.visualstudio.com/items?itemName=yilmaztekinozer.undoc) | ||
|
|
||
| #### React Example | ||
|  | ||
|
|
||
| #### Flow Example | ||
| #### Flow Example | ||
|  | ||
|
|
||
| ## Supports | ||
|
|
||
| 1. ES 6 | ||
| 1. ES6 | ||
| 2. Presets of **React** | ||
| 3. Presets of **Flow** | ||
| 4. States ( only initialized in the constructor ) | ||
|
|
||
| ### Contribute | ||
| ### Contribution | ||
|
|
||
| Feel free to open issues and PRs. You can look [here](https://github.com/oyilmaztekin/vscode-undoc/blob/master/CONTRIBUTING.md) for helper documentations. | ||
|
|
||
| ## Contribution | ||
|
|
||
| 1. Fork it (https://github.com/oyilmaztekin/vscode-undoc/fork) | ||
| 2. Create your branch (`git checkout -b fix/issue-id`) | ||
| 3. Commit your changes (`git commit -am 'Fixed something...'`) | ||
| 4. Push to the branch (`git push origin fix/issue-id`) | ||
| 5. Create a new Pull Request | ||
|
|
||
| ##### TODO | ||
| 1- Create doc with selecting function or method | ||
| 2- Currying function | ||
| 3- PropTypes | ||
| 1. Create doc with selecting function or method | ||
| 2. Currying function | ||
| 3. PropTypes | ||
|
|
||
| ## Thanks | ||
|
|
||
| * [babel](https://github.com/babel) |