Skip to content

Commit 6589ca7

Browse files
committed
docs: ✏️ Added Better README template
This commit includes a better README title generated by https://github.com/kefranabg/readme-md-generator
1 parent 737535a commit 6589ca7

File tree

2 files changed

+60
-3
lines changed

2 files changed

+60
-3
lines changed

README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,58 @@
1-
# FASTIFY Typescript Generator
1+
<h1 align="center">Welcome to fastify-typescript-generator 👋</h1>
2+
<p>
3+
<img alt="Version" src="https://img.shields.io/badge/version-0.0.1BETA-blue.svg?cacheSeconds=2592000" />
4+
<a href="https://github.com/open-devs/fastify-typescript-generator#readme" target="_blank">
5+
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
6+
</a>
7+
<a href="https://github.com/open-devs/fastify-typescript-generator/graphs/commit-activity" target="_blank">
8+
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
9+
</a>
10+
<a href="https://github.com/open-devs/fastify-typescript-generator/blob/master/LICENSE" target="_blank">
11+
<img alt="License: MIT" src="https://img.shields.io/github/license/open-devs/fastify-typescript-generator" />
12+
</a>
13+
</p>
14+
15+
> Generate new Fastify applications similar to express-generate which but sets it up to use TypeScript instead
16+
17+
### 🏠 [Homepage](https://github.com/open-devs/fastify-typescript-generator#readme)
18+
19+
## Install
20+
21+
```sh
22+
npm install
23+
```
24+
25+
## Usage
26+
27+
```sh
28+
npm run start
29+
```
30+
31+
## Run tests
32+
33+
```sh
34+
npm run test
35+
```
36+
37+
## Author
38+
39+
👤 **open devs (open.devs.github@gmail.com)**
40+
41+
* Website: https://opendevs.in/
42+
* Github: [@open-devs](https://github.com/open-devs)
43+
44+
## 🤝 Contributing
45+
46+
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/open-devs/fastify-typescript-generator/issues). You can also take a look at the [contributing guide](https://github.com/open-devs/fastify-typescript-generator/blob/master/CONTRIBUTING.md).
47+
48+
## Show your support
49+
50+
Give a ⭐️ if this project helped you!
51+
52+
## 📝 License
53+
54+
Copyright © 2020 [open devs (open.devs.github@gmail.com)](https://github.com/open-devs).<br />
55+
This project is [MIT](https://github.com/open-devs/fastify-typescript-generator/blob/master/LICENSE) licensed.
56+
57+
***
58+
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "fastify-generator-typescript",
2+
"name": "fastify-typescript-generator",
33
"version": "0.0.1BETA",
4-
"description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
4+
"description": "Generate new Fastify applications similar to express-generate which but sets it up to use TypeScript instead",
55
"scripts": {
66
"fastify-generator-typescript": "node cli.js",
77
"start": "node cli.js",

0 commit comments

Comments
 (0)