Skip to content

Commit da62869

Browse files
authored
readme docs has been updated for version v1.0.1
1 parent 012ca77 commit da62869

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

β€ŽREADME.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
# Gen3 Express
2-
A gen3 tool to generate get started express app.
1+
## Changelogs 1.0.1
2+
3+
> [!TIP]
4+
> nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
5+
> docs have also been updated.
36
47
## Acknowledgements
58
You need to know atleast basics about these things.
69
- [NodeJS](https://nodejs.org/docs/latest/api/)
710
- [ExpressJS](https://expressjs.com/en/5x/api.html)
811
- [Embedded JS](https://ejs.co/)
912

10-
## Features
11-
12-
- Minimal and Useful πŸ’«
13-
- JS Hot Reloadings πŸš€
14-
- EJS and Static Hot Reloadings πŸ“œ
15-
- Cross Platform βš”
16-
- NPX (no need to install extra stuff) πŸ₯™
1713
## Installation
1814
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.
1915

@@ -51,7 +47,7 @@ npm run sync
5147
```
5248
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.
5349
```bash
54-
npm run server & npm run server
50+
npm run server & npm run sync
5551
```
5652

5753
## File Cases
@@ -60,13 +56,14 @@ To know about the product or project structure read about files included in this
6056
```bash
6157
.
6258
β”œβ”€β”€ app.js # this core file handles express functions and server.
63-
β”œβ”€β”€ nets.js # this file provides functions to display available ip addresses on your network.
6459
β”œβ”€β”€ package.json # package file handles dependencies, and details about the product.
6560
β”œβ”€β”€ public # this folder contains public data like fonts, css and multimedia.
6661
β”‚Β Β  β”œβ”€β”€ fonts
6762
β”‚Β Β  β”‚Β Β  └── sans.woff
6863
β”‚Β Β  └── style.css
6964
β”œβ”€β”€ sync.js # this file is needed to configure hot reloadings in ejs and static files.
65+
β”œβ”€β”€ utils
66+
β”‚Β Β  └── nets.js # this file provides functions to display available ip addresses on your network.
7067
└── views # this folder contains ejs or html files to render contents.
7168
└── home.ejs # this file is the landing page of the product.
7269
```

0 commit comments

Comments
Β (0)