gen3 has been published at npmjs.

- docs are updated
- changelogs are updated
- version has been updated
- added readme file to display on npmjs site

.npmignore

@@ -1,5 +1,4 @@
 /README.md
+/docs
 /.github
-/docs/.vitepress
 /package-lock.json
-/docs/.vitepress/dist

README.md

@@ -0,0 +1,80 @@
+# Gen3 Express
+A gen3 tool to generate express app boilerplate.
+
+## Acknowledgements
+You need to know atleast basics about these things.
+ - [NodeJS](https://nodejs.org/docs/latest/api/)
+ - [ExpressJS](https://expressjs.com/en/5x/api.html)
+ - [Embedded JS](https://ejs.co/)
+
+## Installation
+You can install and generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.
+
+### 1. node package extecutor
+This method is highly recommended to generate an express app.
+```bash
+npx gen3-express my-app
+```
+
+### 2. node package manager
+Generation of an express app is not recommended through npm.
+```bash
+npm install -g gen3-express
+```
+```bash
+gen3-express my-app
+```
+
+## Documentation
+To install all dev dependencies goto the folder and hit `npm install` command.
+```bash
+cd my-app
+npm install
+```
+To start a dev server to preview page use `server` word.
+- Keep in mind that
+- The below command does not include EJS live reloading.
+
+```bash
+npm run server
+```
+To start a dev server to live preview EJS page use `sync` word.
+```bash
+npm run sync
+```
+If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
+```bash
+npm run server & npm run sync
+```
+
+## File Cases
+To know about the product or project structure read about files included in this code block.
+
+```bash
+.
+├── app.js # this core file handles express functions and server.
+├── package.json # package file handles dependencies, and details about the product.
+├── public # this folder contains public data like fonts, css and multimedia.
+│   ├── fonts
+│   │   └── sans.woff
+│   └── style.css
+├── sync.js # this file is needed to configure hot reloadings in ejs and static files.
+├── utils
+│   └── nets.js # this file provides functions to display available ip addresses on your network.
+└── views # this folder contains ejs or html files to render contents.
+    └── home.ejs # this file is the landing page of the product.
+```
+
+## Roadmap
+
+- Custom name in `package.json` file ✅
+- Excellent terminal user interface ✅
+- Prompt `package.json` file's details from user. ⏩ 
+- Post this project to npmjs website. ✅
+- Custom local template feature ⏩
+
+## Authors
+- [@OurCodeBase](https://www.github.com/OurCodeBase)
+
+## Contributing
+Contributions are always welcome!

docs/changelogs.md

@@ -1,11 +1,17 @@
 # Changelogs
 You can check most latest changlogs at [commits](https://github.com/OurCodeBase/gen3-express/commits/main/) or [versions](https://github.com/OurCodeBase/gen3-express/releases) sections in github.
 
+## Changelogs 1.1.1
+generator published at npmjs.
+- docs updated
+- package updated
+- npm ignore file updated
+
 ## Changelogs 1.1.0
 tui has been implemented to gen3-express.
 - used signale to implement tui.
 - changes many things in gen3-express file.
 
 ## Changelogs 1.0.1
 - nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
-- docs have also been updated.
+- docs have also been updated.

docs/readme.md → docs/documentation.md

@@ -1,10 +1,11 @@
 # Gen3 Express
 A gen3 tool to generate express app boilerplate.
 
-## Changelogs 1.1.0
-tui has been implemented to gen3-express.
-- used signale to implement tui.
-- changes many things in gen3-express file.
+## Changelogs 1.1.1
+generator published at npmjs.
+- docs updated
+- package updated
+- npm ignore file updated
 
 ## Acknowledgements
 You need to know atleast basics about these things.
@@ -18,13 +19,13 @@ You can install and generate an express app using this tool in two approaches. H
 ### 1. node package extecutor
 This method is highly recommended to generate an express app.
 ```bash
-npx https://www.github.com/OurCodeBase/gen3-express my-app
+npx gen3-express my-app
 ```
 
 ### 2. node package manager
 Generation of an express app is not recommended through npm.
 ```bash
-npm install -g https://www.github.com/OurCodeBase/gen3-express.git
+npm install -g gen3-express
 ```
 ```bash
 gen3-express my-app
@@ -75,11 +76,11 @@ To know about the product or project structure read about files included in this
 - Custom name in `package.json` file ✅
 - Excellent terminal user interface ✅
 - Prompt `package.json` file's details from user. ⏩ 
-- Post this project to npmjs website. ⏩
+- Post this project to npmjs website. ✅
 - Custom local template feature ⏩
 
 ## Authors
 - [@OurCodeBase](https://www.github.com/OurCodeBase)
 
 ## Contributing
-Contributions are always welcome!
+Contributions are always welcome!

docs/index.md

@@ -11,7 +11,7 @@ hero:
     actions:
     - theme: brand
       text: Get Started
-      link: /readme
+      link: /documentation
     - theme: alt
       text: View on GitHub
       link: https://github.com/OurCodeBase/gen3-express

package.json

@@ -1,8 +1,7 @@
 {
   "name": "gen3-express",
-  "version": "1.0.0",
-  "description": "A gen3 tool to generate get started express app",
-  "main": "index.js",
+  "version": "1.1.1",
+  "description": "A gen3 tool to generate express app boilerplate.",
   "bin": {
     "gen3-express": "./bin/gen3-express.js"
   },
@@ -26,7 +25,7 @@
   "bugs": {
     "url": "https://github.com/OurCodeBase/gen3-express/issues"
   },
-  "homepage": "https://github.com/OurCodeBase/gen3-express#readme",
+  "homepage": "https://ourcodebase.github.io/gen3-express",
   "dependencies": {
     "commander": "^12.1.0",
     "fs-extra": "^11.2.0",