docs: 📝 Update readme

add banner and other details to readme.md
doroudi · Mar 7, 2024 · 2cc4b15 · 2cc4b15
1 parent 188a404
commit 2cc4b15
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 
 # YummyAdmin
 
-Vue3 and NaiveUI Based admin panel based on commercial use cases. 
+Vue3 and NaiveUI Based admin panel based on commercial use cases.
 Supporting RTL, Beautiful design, Ready to use and expandable for any other use cases.
 
-<p align='center'>
-
-</p>
+![Preview](/docs/banner.png "Preview")
 
+> **Note**: 🚧 This Project is under active construction and not 100 percent ready.
+> 
 <br>
-
 <p align='center'>
 <a href="https://yummyadmin.netlify.app/">Live Demo</a>
 </p>
@@ -104,7 +103,7 @@ And, enjoy :)
 Just run and visit http://localhost:7000
 
 ```bash
-pnpm dev
+pnpm dev:mock
 ```
 
 ### Build

diff --git a/docs/banner.png b/docs/banner.png