Update README.md

animhotep · Feb 2, 2024 · f8fe93f · f8fe93f
1 parent 0f138c0
commit f8fe93f
Showing 1 changed file with 11 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -8,18 +8,16 @@
   Free and beautiful Vue.js admin template with 44+ custom UI components.</br>
   Developed by  <a href="https://epicmax.co">Epicmax</a>.
   Designed by <a href="#">Vasili Savitski</a>
-<br>
-Based on <a href="https://github.com/epicmaxco/vuestic-ui">Vuestic UI</a> library.
 </p>
 
 <p align="center">
-  <a href="https://admin.vuestic.dev/admin/dashboard?theme=light"> Light theme demo </a> | <a href="https://admin.vuestic.dev/admin/dashboard?theme=semi-dark">Semi-dark theme demo </a> | <a href="https://admin.vuestic.dev/admin/dashboard?theme=original">Original theme demo </a> | <a href="https://vuestic.dev"> Vuestic UI documentation </a>
+  <a href="https://admin.vuestic.dev/admin/dashboard"> Demo </a> | <a href="https://vuestic.dev"> Vuestic UI </a> | <a href="https://discord.gg/u7fQdqQt8c">Discord</a>
 </p>
 
-> Vuestic Admin is built with Vuestic UI. See our
+> Vuestic Admin is built with [Vuestic UI](https://ui.vuestic.dev). See our
 > <a href="https://github.com/epicmaxco/vuestic-ui/issues">issues</a>,
 > <a href="https://vuestic.dev/en/contribution/guide">contributing guide</a> and join discussions on our
-> <a href="https://discord.gg/jTKTjj2weV">discord server</a> to help us improve Vuestic Admin & Vuestic UI experience.
+> <a href="https://discord.gg/jTKTjj2weV">Discord server</a> to help us improve Vuestic Admin & Vuestic UI experience.
 
 <p align="center">
   <a href="https://admin.vuestic.dev" target="_blank">
@@ -33,111 +31,18 @@ Based on <a href="https://github.com/epicmaxco/vuestic-ui">Vuestic UI</a> librar
   </a>
 </p>
 
-### Documentation
-
-Documentation, guides and tutorials are available
-on <a href="https://vuestic.dev">vuestic.dev</a>
-
-### Official Discord Server
-
-Ask questions at the official
-community [discord server](https://discord.gg/jTKTjj2weV)
-
-### Installation
-
-First of all, make sure you have all prerequisites installed:
-
-- [Node.js](https://nodejs.org/en/) ( >=14.\*)
-- [npm](https://www.npmjs.com/get-npm) version 3+ (
-  or [yarn](https://yarnpkg.com/lang/en/docs/install) version 1.16+)
-  and [Git](https://git-scm.com).
-
-After checking the prerequisites, follow these simple steps to install and use
-Vuestic Admin:
-
-```
-# clone the repo
-$ git clone https://github.com/epicmaxco/vuestic-admin.git myproject
-
-# go into app's directory and install dependencies:
-$ cd myproject
+### Quick start
+Use following command to quickly scaffold new [Vuestic Admin](admin.vuestic.ui) or empty Vite or Nuxt project with [Vuestic UI](ui.vuestic.dev).
 
+```bash
+npm create vuestic@latest
 ```
 
-Then, if you use npm:
+After [Vuestic Admin](admin.vuestic.ui) is installed, run `npm install` to install dependcies, then run `npm run dev` to start local development server.
 
-```
-$ npm install
-
-# serve with hot reload at localhost:8080 by default.
-$ npm run dev
-
-# build for production
-$ npm run build
-
-# build for production and view the bundle analyzer report.
-$ npm run build --report
-```
-
-If you use yarn:
-
-```
-$ yarn install
-
-# serve with hot reload at localhost:8080 by default.
-$ yarn dev
-
-# build for production
-$ yarn build
-
-# build for production and view the bundle analyzer report.
-$ yarn build --report
-```
+### Documentation
 
-### Features
-
-[Responsive layout](https://admin.vuestic.dev/admin/dashboard) |
-[charts (Chart.js)](https://admin.vuestic.dev/admin/statistics/charts) |
-[progress bars](https://admin.vuestic.dev/admin/statistics/progress-bars) |
-[forms](https://admin.vuestic.dev/admin/forms/form-elements) |
-[selects](https://admin.vuestic.dev/admin/forms/form-elements) |
-[date pickers](https://admin.vuestic.dev/admin/forms/form-elements) |
-[checkboxes and radios](https://admin.vuestic.dev/admin/forms/form-elements)
-|
-[static tables and data tables](https://admin.vuestic.dev/admin/tables/data)
-|
-[medium editor](https://admin.vuestic.dev/admin/forms/medium-editor) |
-[smooth typography](https://admin.vuestic.dev/admin/ui/typography) |
-[buttons](https://admin.vuestic.dev/admin/ui/buttons) |
-[collapses](https://admin.vuestic.dev/admin/ui/collapses) |
-[color pickers](https://admin.vuestic.dev/admin/ui/color-pickers) |
-[timelines](https://admin.vuestic.dev/admin/ui/timelines) |
-[toasts](https://admin.vuestic.dev/admin/ui/notifications) |
-[tooltips](https://admin.vuestic.dev/admin/ui/popovers) |
-[popovers](https://admin.vuestic.dev/admin/ui/popovers) |
-[icons](https://admin.vuestic.dev/admin/ui/icons/) |
-[spinners](https://admin.vuestic.dev/admin/ui/spinners) |
-[modals](https://admin.vuestic.dev/admin/ui/modals) |
-[file upload](https://admin.vuestic.dev/admin/ui/file-upload) |
-[chips](https://admin.vuestic.dev/admin/ui/chips) |
-[trees](https://admin.vuestic.dev/admin/ui/tree-view) |
-[cards](https://admin.vuestic.dev/admin/ui/cards) |
-[ratings](https://admin.vuestic.dev/admin/ui/rating) |
-[sliders](https://admin.vuestic.dev/admin/ui/sliders) |
-[chat](https://admin.vuestic.dev/admin/ui/chat) |
-[maps (MapLibre, Yandex, Leaflet, amMap)](https://admin.vuestic.dev/admin/maps/maplibre-maps)
-|
-[login/signup pages templates](https://admin.vuestic.dev/auth/login) |
-[404 pages templates](https://admin.vuestic.dev/admin/pages/404) |
-[i18n](https://admin.vuestic.dev/admin/dashboard)
-
-### Browser Support
-
-We design Vuestic Admin to support the latest modern web browsers.
-
-| <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" /><br>Edge | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /><br>Firefox | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /><br>Chrome | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /><br>Safari | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" /><br>Opera |
-| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Edge                                                                                                                                             | last 2 versions                                                                                                                                              | last 2 versions                                                                                                                                          | last 2 versions                                                                                                                                          | last 2 versions                                                                                                                                      |
+Documentation, guides, examples and tutorials are available on [ui.vuestic.dev](https://vuestic.dev)
 
 ### Contributing
 
@@ -152,7 +57,7 @@ You’re always welcome to join: check out
 our <a href="https://vuestic.dev/en/contribution/guide">
 contribution guides</a>
 , [open issues](https://github.com/epicmaxco/vuestic-ui/issues)
-and [discord server](https://discord.gg/jTKTjj2weV)
+and [Discord server](https://discord.gg/jTKTjj2weV)
 
 ### Partners & Sponsors ❤️