core: readme update

README.md

@@ -1,34 +1,71 @@
 # React Essential
 
-React.js Essential - An Essential Template to build an modern react.js application with all the essentials included.
+An Essential Template to build an Modern React.js application with all the essentials included.
 
 ## Getting Started
 
-#### Radium - [Install Radium CLI](https://github.com/radiumlabs/radium)
+### Prerequisites
 
-`radium` is an CLI tool to initialize any project. It'll install dependencies, initialize as git repository, and prepare your project for development.
+React Essential comes with two variants of the template - `main` [branch](https://github.com/radiumlabs/react-essential/tree/main) starter configured with biome.js for linting and formatting and `eslint-prettier` [branch](https://github.com/radiumlabs/react-essential/tree/eslint-prettier) starter configured with prettier and eslint for linting and formatting. Choose the one that suits you best.
+
+### Radium - [Install Radium CLI](https://github.com/radiumlabs/radium) (Recommended)
+
+`radium` is an CLI tool to initialize any project. By using `radium init --with` command, radium will install dependencies, initialize as git repository, and prepare your project for development by cleaning up the project.
 
 ```bash
 radium init --with
 ```
+
+and then follow the instructions to enter the name of project and url of this template.
+
+### Manual Installation
+
+You can also manually install the template by cloning the repository and installing the dependencies. But initially you have to clean up the project and then start the development server.
+
+```bash
+git clone https://github.com/radiumlabs/react-essential.git
+```
+
 ```bash
-enter the name of project and url of this template
+cd react-essential
 ```
-> `radium` cli will initialize your project with this template and install dependencies, initialize as git repository and prepare your project for development.
+
+Choose your preferred package manager (PNPM or YARN or BUN or NPM) and install the dependencies but before that, you have to clean up the project such as removing the `.git` folder and `bun.lockb` file.
+
+```bash
+git bash
+```
+
+```bash
+rm -rf .git bun.lockb
+```
+
+and then install the dependencies by using the package manager of your choice.
+
+```bash
+pnpm/yarn/bun/npm install
+```
+
+```bash
+pnpm/yarn/bun/npm run dev
+```
+
+### Other Changes
+
+If you're using other package manager than `bun` you have to update the scripts in `package.json` file, workflow in `.github/workflows/build.yml` file and husky configuration in `.husky/pre-commit` file.
 
 ## Features
 
-- ✨ Library: [React.js](https://reactjs.org/)
+- ✨ Framework: [React.js](https://reactjs.org/)
 - 🚀 Styling: [Tailwind CSS](https://tailwindcss.com/)
 - 💻 Language: [TypeScript](https://www.typescriptlang.org/)
-- 🧹 Linting and Formatting: [Biome.js](https://biomejs.dev/)
-- 🎨 Themes: [Next Themes](https://github.com/pacocoursey/next-themes)
-- 💄 Icons: [Radix-Icon](https://www.radix-ui.com/icons)
+- 🧹 Linting and Formatting: [Biome.js](https://biomejs.dev/), [Prettier](https://prettier.io/), [ESLint](https://eslint.org/)
 - 🚀 Routing: [Tanstack React Router](https://tanstack.com/router/)
-- ✨ Heading: [Unheaded](https://github.com/unjs/unhead)
+- 🛠 Heading: [Unheaded](https://github.com/unjs/unhead)
+- 🎨 Themes: [Next Themes](https://github.com/pacocoursey/next-themes)
 - ⚙️ Build: Github Actions
 - 🛠 Commit: [Husky](https://typicode.github.io/husky/)
 
-## Contribute.
+## Contribute
 
-Contributions are always welcome! Please submit a pull request or open an issue to discuss your ideas.
+Contributions are always welcome! Please submit a pull request or open an issue to discuss your ideas.