-
Notifications
You must be signed in to change notification settings - Fork 277
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README and version in package.json
- Loading branch information
1 parent
8313e48
commit d7cbed7
Showing
2 changed files
with
17 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
# Material Angular Dashboard | ||
|
||
Welcome to the first dark dashboard on Material Design Lite and Angular! | ||
Welcome to the first dark dashboard with Google Material Design and Angular! | ||
|
||
![dashboard-avatar](https://trello-attachments.s3.amazonaws.com/55f8466d8f95075bca20dd66/5bf421455ab0f05102cadac9/eee32e50e9fc278b715442a3fc6f65aa/Readme.png) | ||
|
||
Its much more fun with the [demo](http://creativeit.github.io/material-dashboard-lite/index.html). | ||
Its much more fun with the [demo](http://material-angular-dashboard.creativeit.io). | ||
|
||
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. | ||
Material admin template is absolutely free for commercial usage theme, based on Google Material Design guidelines. | ||
|
||
> **Important**: We are still working on the project and there will be much more awesome, check out our [issues](https://github.com/CreativeIT/material-angular-dashboard/issues) to see what features are coming soon. | ||
|
@@ -20,13 +20,13 @@ The steps below will take you through cloning your own fork, installing dependen | |
git clone https://github.com/CreativeIT/material-angular-dashboard.git | ||
``` | ||
|
||
2. Open your copied repo folder in terminal and install necessary modules with command: | ||
2. Open your copied repo folder in terminal and install necessary modules with command, make sure that you have installed [yarn](https://yarnpkg.com/en/docs/install): | ||
|
||
```bash | ||
yarn install | ||
``` | ||
|
||
3. _(optional)_ Install [angular-cli](https://cli.angular.io/) globally to use its commands in the terminal: | ||
3. Install [angular-cli](https://cli.angular.io/) globally to use its commands in the terminal: | ||
|
||
```bash | ||
yarn global add @angular/cli | ||
|
@@ -40,11 +40,11 @@ Run `yarn run build` or `ng build` to build the project. The build artifacts wil | |
|
||
# FEATURES | ||
|
||
* [Material Design](http://www.google.com/design/spec/material-design/introduction.html) via [Material Design Lite](http://getmdl.io) | ||
* Angular | ||
|
||
* TypeScript | ||
* [Material Design](http://www.google.com/design/spec/material-design/introduction.html) | ||
|
||
* Angular | ||
* TypeScript | ||
|
||
* Responsive dark material design. DARK, Carl! | ||
|
||
|
@@ -60,21 +60,21 @@ Run `yarn run build` or `ng build` to build the project. The build artifacts wil | |
|
||
Since the project uses [BEM](http://getbem.com) structure with sass, it can be customized in an easy way by editing `src/theme/scss/_variables.scss` file. | ||
|
||
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. | ||
Project uses [d3](https://d3js.org/) and [nvd3](http://nvd3.org/) to build charts and chart components. | ||
|
||
# Hire us | ||
|
||
We are ready to bring value to your business. Visit our site [creativeit.io](http://creativeit.io/) or drop us a line <[email protected]>. We will be happy to help you! | ||
We are ready to become a strong development partner and bring competitive advantage to your business. Visit our site [creativeit.io](http://creativeit.io/) or drop us a line <[email protected]>. We will be happy to help you! | ||
|
||
# Credits | ||
|
||
UI components built with [Material Design Lite](http://www.getmdl.io). | ||
Material Angular Dashboard was inspired by [html5 material dashboard](https://github.com/CreativeIT/material-dashboard-lite) | ||
|
||
Designed with passion and coffee by CreativeIT. | ||
|
||
# Support the project | ||
|
||
* Star the repo | ||
* Star the repo :star: | ||
|
||
* Create an issue report or feature request | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters