Skip to content

Commit efea8bb

Browse files
committed
create-servest readme updated
1 parent 0aac8e2 commit efea8bb

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

packages/create-servest/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# create-servest <a href="https://npmjs.com/package/create-servest"><img src="https://img.shields.io/npm/v/create-servest" alt="npm package"></a>
22

3-
`create-servest` is a scaffolding tool for quickly setting up modern backend projects. Inspired by [create-vite](https://vitejs.dev/), it allows you to bootstrap projects with or without addons in a streamlined way.
3+
`create-servest` is a scaffolding tool for quickly setting up modern backend projects. Inspired by [create-vite](https://www.npmjs.com/package/create-vite), it allows you to bootstrap projects with or without addons in a streamlined way.
44

55
## Features
66

@@ -89,6 +89,16 @@ This will scaffold the express-mvc-ts project and install the required npm packa
8989

9090
> Note: If any addon fails, the remaining ones will still be applied. You can re-run the failed addons manually later.
9191
92+
> To learn more about servest addons, visit the [npm package](https://www.npmjs.com/package/servest) or check the [GitHub repository](https://github.com/dev-rashedin/servest/blob/main/packages/servest-addons/README.md)
93+
94+
---
95+
96+
## Options
97+
98+
- `-t, --template` – Select a template (e.g., `express-basic-js`, `express-mvc-ts`)
99+
- `-a, --addons` – Space-separated list of addons (optional)
100+
- `-h, --help` – Show help message
101+
92102
---
93103

94104
## Community Templates
@@ -121,6 +131,10 @@ Contributions are welcome! Please open an issue or submit a pull request if you
121131

122132
---
123133

134+
## Inspiration
135+
136+
This project was heavily inspired by [create-vite](https://www.npmjs.com/package/create-vite) for project scaffolding and [shadcn](https://ui.shadcn.com) for addons, for addons, adopting a similar philosophy for backend scaffolding and utility generation..
137+
124138
## License
125139

126140
MIT License

packages/create-servest/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-servest",
3-
"version": "1.2.0-beta.5",
3+
"version": "1.2.0",
44
"type": "module",
55
"license": "MIT",
66
"author": "Rashedin Islam <https://www.rashedin.dev>",

0 commit comments

Comments
 (0)