Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexbananabob committed Mar 11, 2016
1 parent 6fe64f3 commit da249a8
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Welcome to first dark dashboard on the Material Design Lite!

![dashboard-avatar](https://trello-attachments.s3.amazonaws.com/56af74f7f1b5b81a201453c4/2000x1105/aebadb1186036fc73544e7fde0e43863/Darkboard_Showcase_1_3.png)
![dashboard-avatar](https://trello-attachments.s3.amazonaws.com/56af74f7f1b5b81a201453c4/2000x1105/796e1dae05e88ba87162dd8bbf188e65/Darkboard_Showcase_1_3.png)

Its much more fun with the [demo](http://creativeit.github.io/getmdl-dashboard/index.html).

Material admin template is absolutely free for commecial usage theme, that uses google's implementation of material design -- [Material Design Lite](http://www.getmdl.io) library. It doesn’t rely on any JavaScript frameworks and aims to be responsive and optimized for cross-device usage. All components are created with CSS (scss), JavaScript (es6), and HTML5.
Material admin template is absolutely free for commercial usage theme, that uses google's implementation of material design -- [Material Design Lite](http://www.getmdl.io) library. It doesn’t rely on any JavaScript frameworks and aims to be responsive and optimized for cross-device usage. All components are created with CSS (scss), JavaScript (es6), and HTML5.

>**Important**: We are still working on the project and there will be much more awesomes, check out our [issues](https://github.com/CreativeIT/getmdl-dashboard/issues) to see what features are coming soon.
>**Important**: We are still working on the project and there will be much more awesome, check out our [issues](https://github.com/CreativeIT/getmdl-dashboard/issues) to see what features are coming soon.
#SETUP and USAGE
The steps bellow will take you through clonning your own fork, installing dependencies and building:
The steps bellow will take you through cloning your own fork, installing dependencies and building:

1. Fork and/or clone our repository. To use Git from command line, see the [Setting up Git](https://help.github.com/articles/set-up-git/) and [Fork a repo](https://help.github.com/articles/fork-a-repo/) articles.

Expand Down Expand Up @@ -46,9 +46,9 @@ The steps bellow will take you through clonning your own fork, installing depend

##Additional

Since the project uses [BEM](http://getbem.com) structure with sass, it can be customized in easy way by editing `src/variables.scss` file. To take affect you must run `gulp build` in terminal again. Also you may want to use `gulp watch`, that will run default command every time you modify any file in source folder. You can use `gulp default`if you don't want to minify js-files.
Since the project uses [BEM](http://getbem.com) structure with sass, it can be customized in easy way by editing `src/variables.scss` file. To take effect you must run `gulp build` in terminal again. Also you may want to use `gulp watch`, that will run default command every time you modify any file in source folder. You can use `gulp default`if you don't want to minify js-files.

Google hasn't implemented select element yet ([see why here](http://37.media.tumblr.com/6a9fcffde2da977266b0ea99b15d5803/tumblr_n42cjjsriB1smcbm7o1_400.gif)), that is why project depends on [getmdl-select plugin](https://github.com/CreativeIT/getmdl-select). Also project uses [d3 and nvd3](http://nvd3.org/) to build charts and chart components.
Google hasn't implemented select element yet ([see why here](http://37.media.tumblr.com/6a9fcffde2da977266b0ea99b15d5803/tumblr_n42cjjsriB1smcbm7o1_400.gif)), that is why the project depends on [getmdl-select plugin](https://github.com/CreativeIT/getmdl-select). Also project uses [d3](https://d3js.org/) and [nvd3](http://nvd3.org/) to build charts and chart components.


#FEATURES
Expand All @@ -59,6 +59,8 @@ Google hasn't implemented select element yet ([see why here](http://37.media.tum

* Responsive dark material design. DARK, Carl!

* User experience focused

* [Sass](http://sass-lang.com/)

* [Gulp](http://gulpjs.com/) build
Expand All @@ -71,4 +73,14 @@ Google hasn't implemented select element yet ([see why here](http://37.media.tum

UI components built with [Material Design Lite](http://www.getmdl.io).

Design by CreativeIT.
Designed with passion and coffee by CreativeIT

#Support the project

* Star the repo

* Create issue report or feature request

* [Tweet about it](https://twitter.com/intent/tweet?text=Wow!%20New%20%23free%20dark%20%23dashboard%20on%20%23MaterialDesignLite!%0Ahttp://creativeit.github.io/getmdl-dashboard/index.html%0A&via=CreativeITeam&hashtags=materialDesign,responsive,UI,JS)

* Follow [us on Twitter](https://twitter.com/intent/follow?screen_name=CreativeITeam)

0 comments on commit da249a8

Please sign in to comment.