From c506c0c689d97194e8f697eb26286093f51da489 Mon Sep 17 00:00:00 2001 From: neelbrahmakshatriya Date: Mon, 24 Jun 2024 13:34:25 +0530 Subject: [PATCH] refactor: update readme file Added features and deployment sections --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a4bc24e7..d069fe9b5 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,31 @@ If you're a developer looking for the most Powerful & comprehensive [Free MUI Ne Build premium quality applications with ease. Use one of the most innovative [NextJS admin templates](https://themeselection.com/item/category/next-js-admin-template) to create eye-catching, high-quality WebApps. Your apps will be completely responsive, ensuring they'll look stunning and function flawlessly on desktops, tablets, and mobile devices. -Materio provides a template with Javascript and Typescript. +Materio provides a template with TypeScript and JavaScript. [View Demo](https://demos.themeselection.com/materio-mui-nextjs-admin-template-free/demo) +## Features 📋 + +- ⚡ [Next.js](https://nextjs.org) with App Router support +- 💎 Integrated with [MUI](https://mui.com) & [Tailwind CSS](https://tailwindcss.com) +- ✅ [TypeScript](https://www.typescriptlang.org) & JavaScript Support +- 📏 Linter with [ESLint](https://eslint.org) +- 💖 Code Formatter with [Prettier](https://prettier.io) +- 🗂 VSCode configuration: Settings, Extensions and Custom Snippets +- 💡 Absolute Imports with aliases +- ☕ Minify HTML & CSS +- 💨 Live reload +- ✅ Cache busting +- 🛠️ Easy to customize +- 😎 SEO-friendly +- 🚀 Production-ready + +## Requirements ✅ + +- Node.js LTS version (not current version) +- npm + ## Installation ⚒️ Installing and running the template is super easy in Materio, please follow these steps and you should be ready to rock 🤘: @@ -121,6 +142,10 @@ Installing and running the template is super easy in Materio, please follow thes Check out our live [Documentation](https://demos.themeselection.com/materio-mui-nextjs-admin-template/documentation) +## Deployment 🚀 + +Check out our [Deployment docs](https://demos.themeselection.com/materio-mui-nextjs-admin-template/documentation/docs/guide/deployment) + ## Browser Support 🖥️ ![chrome](https://github.com/nuxt/nuxt/assets/47495003/bbb6d7b0-2db6-4af4-abdc-a73de71dd287)