From 509de7625c9dbe53182834fa619e9d05965ef7b4 Mon Sep 17 00:00:00 2001 From: Shyam Mahanta Date: Sun, 6 Apr 2025 22:58:07 +0530 Subject: [PATCH] readme work on js-base --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 527b115..5322934 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# js-base-setup \ No newline at end of file +#### What is this repo all about? + +- This repo offers a basic setup of a javascript web project which comes with some feature out of the box like page based routing, taiwindcss (optional) etc. So when you are starting a new javascript project why to setup from scratch instead of uing this. + +#### How to run this project? + +- you can run `npm run start` to start the project instantly and in order to build tailwindcss (although it builds runtime) you have to run `npm run build` which actually builds the tailwindcss. + +#### Want to Contribute or Find a bug? + +- We are very happy if you want to make improvement on this repo. Please never hesitate to create an issue & pull request.