From 427adb32acaabb2f62c1161a955e5f6e7661c0e1 Mon Sep 17 00:00:00 2001 From: creations Date: Thu, 5 Sep 2024 18:10:25 -0400 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++++++++++++--------- 1 file changed, 33 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 414cf33..d0a4d5c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,44 @@ -# TS Fastify Example +# TypeScript Fastify Starter Template -This is just an example/template to get you started with Fastify and TypeScript. It starts off using EJS, but you can use something else if you'd like. +This template is designed to help you get started with Fastify and TypeScript. By default, it uses **EJS** as the templating engine, but feel free to replace it with any other engine that suits your project. ## Getting Started -To start the project, you can run either `start.bat` or `start.sh`. +### For Windows: +Use the following commands via `start.bat`: -## Cleanup +- **Start the project:** `start.bat` +- **Clean up the project:** `start.bat clean` +- **Change mode:** `start.bat mode ` -You can clean up your project with the following commands: +### For Unix/Linux: +Use the following commands via `start.sh`: -- **Windows:** `start.bat clean` -- **Unix/Linux:** `start.sh clean` +- **Start the project:** `start.sh` +- **Clean up the project:** `start.sh clean` +- **Change mode:** `start.sh mode ` -Have fun - **Creations** // **creations@creations.works** +### Mode Options: +You can set the following modes: + +- `dev` or `development` +- `prod` or `production` + +## Package Manager Support + +You can switch the package manager for the project with the following allowed managers: + +- **bun** +- **npm** +- **yarn** +- **pnpm** ## License -This project is licensed under the MIT License - see the [LICENSE](https://creations.works/creations/TSFastifyExample/src/branch/main/LICENCE) file for details. \ No newline at end of file +This project is licensed under the MIT License - see the [LICENSE](https://creations.works/creations/TSFastifyExample/src/branch/main/LICENCE) file for details. + +--- + +Have fun! +**Creations** +**creations@creations.works**