Skip to content

Commit 5fe2290

Browse files
authored
Update README.md
1 parent f89178f commit 5fe2290

1 file changed

Lines changed: 57 additions & 9 deletions

File tree

README.md

Lines changed: 57 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,40 @@
1-
2-
<img height="128" src="https://user-images.githubusercontent.com/22912150/89680591-e9418e80-d8fb-11ea-93f7-1631ea571f33.png" alt="logo" />
3-
4-
# React CodeGen CLI
5-
6-
React CodeGen is a development tool to quickly generate React components.
7-
It helps you to speed up productivity in React projects and stop copying, pasting files.
1+
![NPM version](https://img.shields.io/npm/v/react-codegen-cli?style=flat-square&color=1e88e5)
2+
![GitHub stars](https://img.shields.io/github/stars/Cristians953/react-codegen-cli?style=flat-square&color=yellow)
3+
[![NPM total downloads](https://img.shields.io/npm/dt/react-codegen-cli.svg?style=flat-square)](https://npmcharts.com/compare/react-virtualized?minimal=true)
4+
[![NPM monthly downloads](https://img.shields.io/npm/dm/react-codegen-cli.svg?style=flat-square&color=03a9f4)](https://npmcharts.com/compare/react-virtualized?minimal=true)
5+
![NPM license](https://img.shields.io/npm/l/react-codegen-cli?style=flat-square)
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square&color=66bb6a)](https://github.com/Cristians953/react-codegen-cli/issues)
7+
8+
9+
<br />
10+
<p align="center">
11+
<a href="https://github.com/Cristians953/react-codegen-cli">
12+
<img height="128" src="https://user-images.githubusercontent.com/22912150/89680591-e9418e80-d8fb-11ea-93f7-1631ea571f33.png" alt="logo" />
13+
</a>
14+
15+
<h1 align="center">React CodeGen CLI</h1>
16+
17+
<p align="center">
18+
React CodeGen is a development tool to quickly generate React components.
19+
It helps you to speed up productivity in React projects and stop copying, pasting files.
20+
<br />
21+
<a href="#get-started">Get Started</a>
22+
·
23+
<a href="https://github.com/Cristians953/react-codegen-cli/issues">Report Bug</a>
24+
·
25+
<a href="https://github.com/Cristians953/react-codegen-cli/issues">Request Feature</a>
26+
</p>
27+
</p>
28+
29+
## Table of Contents
30+
31+
* [Installation](#installation)
32+
* [Get Started](#get-started)
33+
* [Configuration File](#configuration-file)
34+
* [Configuration Options](#configuration-options)
35+
* [Roadmap](#roadmap)
36+
* [Contributing](#contributing)
37+
* [License](#license)
838

939
## Installation
1040

@@ -50,15 +80,19 @@ React CodeGen uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig)
5080
`react-codegen` will look for a [configuration file](#configuration-file) in root folder and use it if available.
5181
If no config file found it will fallback to a default configuration.
5282

53-
### Configuration Options
83+
## Configuration Options
5484

5585
| Type | Value | Default | Description |
5686
|:------------:|:------------------------------------------------------------:|:--------------:|----------------------------------------------------------------------|
5787
| styles | string | scss | Stylesheet format |
5888
| typescript | boolean | false | Generate typescript files |
5989
| jsxExt | boolean | true | Use `jsx` extension for components |
6090
| fileNameCase | came,<br/> pascal,<br/> snake,<br/> snakeUpper,<br/> kebab | pascal | File name case for generated files<br/> (default: `MyComponent.jsx`) |
61-
| path | string | src/components | Path to generate files | | |
91+
| path | string | src/components | Path to generate files
92+
| wrapFolder | boolean | true | Create a wrap folder for generated files |
93+
| cssModules | boolean | false | Generate css module |
94+
| exportType | default,<br /> named | default | Export type to be used for modules
95+
| arrowFunction | boolean | true | Use arrow functions insead of regular
6296

6397
Example:
6498

@@ -72,6 +106,20 @@ Example:
72106
}
73107
```
74108

109+
## Roadmap
110+
111+
See the [open issues](https://github.com/Cristians953/react-codegen-cli/issues) for a list of proposed features (and known issues).
112+
113+
## Contributing
114+
115+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
116+
117+
1. Fork the Project
118+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
119+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
120+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
121+
5. Open a Pull Request
122+
75123
## License
76124

77125
React CodeGen CLI is open source software [licensed as MIT](https://github.com/cristians953/react-codegen/blob/master/LICENSE).

0 commit comments

Comments
 (0)