docs: ✏️ Types defintion for options

This commit includes changes to docs to better describe the different
options that are available in fastify-typescript-generator

Author: mikr13

README.md

@@ -1,49 +1,94 @@
-<h1 align="center">Welcome to fastify-typescript-generator 👋</h1>
+<h1 align="center">welcome to fastify-typescript-generator 👋</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-0.0.1BETA-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-0.0.3-blue.svg?cacheSeconds=2592000" />
   <a href="https://github.com/open-devs/fastify-typescript-generator#readme" target="_blank">
-    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-blue.svg" />
   </a>
   <a href="https://github.com/open-devs/fastify-typescript-generator/graphs/commit-activity" target="_blank">
-    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained-yes-blue.svg" />
   </a>
   <a href="https://github.com/open-devs/fastify-typescript-generator/blob/master/LICENSE" target="_blank">
     <img alt="License: MIT" src="https://img.shields.io/github/license/open-devs/fastify-typescript-generator" />
   </a>
 </p>
 
-> Generate new Fastify applications similar to express-generate which but sets it up to use TypeScript instead
+> generates new [fastify](https://www.fastify.io/) applications in everyone's favourite language [typescript](https://github.com/microsoft/TypeScript) with various options to choose from based on your project needs
 
-### 🏠 [Homepage](https://github.com/open-devs/fastify-typescript-generator#readme)
+### 🏠 [homepage](https://github.com/open-devs/fastify-typescript-generator#readme)
 
-## Install
+## install
 
 ```sh
 npm install
 ```
 
-## Usage
+## usage
 
 ```sh
 npm run start
 ```
 
-## Run tests
+## ❓ what is it
+
+creates a new fastify application similar to the fastify-cli module. except this new application is configured to use typeScript instead of plain javascript and provides various options such as, kind of project structure to use with focus on plugin structure for fastify developers and express structure for developers with experience in developing with express, it also provides options for typeorm or mongoose.
+
+## 🤔 why fastify-typescript-generator
+
+nodejs is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. typescript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like java.
+
+there are some other tools out there to generate fastify apps with javascript such as fastify-cli, but these either haven't been updated in a while or don't support typescript or don't support various development patterns.
+
+in this application you have two options to setup a project in fastify plugin architecture or express architecture, we have setup mongoose/typeorm integration, routes, swagger (in plugin structure only) for you.
+
+## 📜 different options available explained
+
+<table>
+<caption>description of various options available</caption>
+<thead>
+<tr>
+<th>name</th>
+<th>description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>plugin-structure-mongoose</td>
+<td>this type of structure includes fastify plugin structure which relies on modules described as reusable plugins that contain their own entities, routes & schemas, additionally paired with swagger and mongoose for connection with mongodb</td>
+</tr>
+<tr>
+<td>plugin-structure-typeorm</td>
+<td>this type of structure includes fastify plugin structure which relies on modules described as reusable plugins that contain their own entities, routes & schemas, additionally paired with swagger and typeorm for connection with various sql (like postgresql, mysql) and no-sql databases (like mongodb)</td>
+</tr>
+<tr>
+<td>express-structure-mongoose</td>
+<td>this type of structure includes express generator structure which relies on models, routes, dao, services, additionally paired with swagger and mongoose for connection with mongodb</td>
+</tr>
+<tr>
+<td>express-structure-typeorm</td>
+<td>this type of structure includes express generator structure which relies on models, routes, services, additionally paired with swagger and typeorm for connection with various sql (like postgresql, mysql) and no-sql databases (like mongodb)</td>
+</tr>
+</tbody>
+</table>
+<br>
+
+Happy web-deving 😊
+
+## author
 
-```sh
-npm run test
-```
+👤 **open devs (open.devs.github@gmail.com)**
 
-## Author
+* website: https://opendevs.in/
+* github: [@open-devs](https://github.com/open-devs)
 
-👤 **open devs (open.devs.github@gmail.com)**
+## 🚀 future scope
 
-* Website: https://opendevs.in/
-* Github: [@open-devs](https://github.com/open-devs)
+* adding docker & container configurations
+* adding template support
+* more template structures
 
 ## 🤝 Contributing
 
-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).
+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).
 
 ## Show your support
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-typescript-generator",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Generate new Fastify applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "fastify-generator-typescript": "node cli.js",