Update README.md

zerogx3 · Jul 13, 2020 · acc095d · acc095d
1 parent 0331333
commit acc095d
Showing 1 changed file with 39 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
-# Voler Admin Dashboard
-Voler is a Admin Dashboard Template that can help you develop faster. Made with Bootstrap 5 Alpha. No jQuery dependency.
 
+<p align="center">
+  <a href="#">
+    <img src="https://github.com/zuramai/voler/blob/master/dist/assets/images/favicon.svg?raw=true" alt="Stisla logo" width="75" height="75">
+  </a>
+</p>
+
+<h1 align="center">Voler</h1>
+<div align="center">
+  Voler is a Admin Dashboard Template that can help you develop faster. Made with Bootstrap 5 Alpha. No jQuery dependency.
+</div>
 <span align="center">
 
 [![All Contributors](https://img.shields.io/badge/all_contributors-1-green.svg?style=flat-square)](#contributors-)
@@ -10,7 +18,34 @@ Voler is a Admin Dashboard Template that can help you develop faster. Made with
 ![npm version](https://badge.fury.io/js/yarn.svg)
 </span>
 
-![Voler logo](https://github.com/zuramai/voler/blob/master/dist/assets/images/screenshot.png?raw=true)
+![Voler dashboard](https://github.com/zuramai/voler/blob/master/screenshot.png?raw=true)
+
+## Installation
+1. Clone this repository.
+```bash
+git clone https://github.com/zuramai/voler
+```
+2. Open ```dist/index.html``` in browser.
+
+## Demo
+You can open the demo <a href="zuramai.github.io/voler/dist" target="_blank">here</a>
+
+## Contributing
+
+- Fork it ( https://github.com/zuramai/voler/fork )
+- Create your feature branch (`git checkout -b my-new-feature`)
+- Commit your changes (`git commit -am 'Add some feature'`)
+- Push to the branch (`git push origin my-new-feature`)
+- Create a new Pull Request
+
+### Note
+- If you want to make some changes in the CSS style. Don't edit the `.css` file, use the SCSS file instead.
+- Since we use Nunjucks, if you want to make changes to the HTML structure, make sure you change the source file (Nunjucks) located in `src`.
+
+## License
+Voler is under MIT License
+
+## About the Author
+Voler is created by <a href="http://ahmadsaugi.com">Ahmad Saugi</a>. You can donate me at <a href="https://trakteer.id/ahmad-saugi">Trakteer</a>
 
-<a href="#" target="_blank">You can see the demo here</a>