File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,40 @@
11
# create-typescript-api
22
CLI to generate base project to start developing APIs with TypeScript.
3+
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT) [![npm version](https://badge.fury.io/js/create-typescript-api.svg)](https://badge.fury.io/js/create-typescript-api) [![npm downloads](https://img.shields.io/npm/dm/create-typescript-api.svg)](https://www.npmjs.com/package/create-typescript-api)
5+
6+
[![NPM](https://nodei.co/npm/create-typescript-api.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/create-typescript-api/) [![NPM](https://nodei.co/npm-dl/create-typescript-api.png?months=9&height=2)](https://nodei.co/npm/create-typescript-api/)
7+
8+
## Installation
9+
10+
**YARN**
11+
12+
```javascript
13+
yarn add create-typescript-api
14+
```
15+
16+
**NPM**
17+
18+
```javascript
19+
npm install --save create-typescript-api
20+
```
21+
22+
## Usage
23+
24+
```bash
25+
create-typescript-api
26+
```
27+
28+
This will display you an input to introduce the projectName or project path. Hit enter and wait, and then you're good to go!
29+
30+
## Issues
31+
32+
If you found a bug, or you have an answer, or whatever. Please, open an [issue](https://.com/BlackBoxVision/create-typescript-api/issues). We will do our best to fix it.
33+
34+
## Contributing
35+
36+
Of course, if you see something that you want to upgrade from this library, or a bug that needs to be solved, **PRs are welcome!**
37+
38+
## License
39+
40+
Distributed under the **MIT license**. See [LICENSE](https://.com/BlackBoxVision/create-typescript-api/blob/master/LICENSE) for more information.

0 commit comments

Comments
 (0)