mdbootstrap/mdb-ui-kit
1
1
Fork 0
mirror of https://github.com/mdbootstrap/mdb-ui-kit.git synced 2024-11-23 01:57:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

shrink readme since the new docs have all the information (no need to have it in two places)

Browse Source
This commit is contained in:
Kevin Ross 2015-11-25 16:12:12 -06:00
parent 6e59be5f96
commit feac2e0d71
2 changed files with 9 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -6,47 +6,22 @@
[![gratipay](https://img.shields.io/gratipay/FezVrasta.svg)](https://gratipay.com/FezVrasta)
[![Bower version](https://badge.fury.io/bo/bootstrap-material-design.svg)](https://github.com/FezVrasta/bootstrap-material-design)
[![banner](demo/imgs/banner.jpg)](#)
Bootstrap Material Design is the best way to use [Material Design guidelines by Google](http://www.google.com/design/spec/material-design/introduction.html)
in your Bootstrap 4 based application. Since this is a fully customizable version of Bootstrap,
just include Bootstrap Material Design CSS instead of Bootstrap CSS, and include the JavaScript at
the end of your document (just before the `</body>` tag), and everything will be converted to Material Design (Paper) style.
the end of your document (just before the `</body>` tag), and everything will be converted to Material Design.
TODO: docs/demo link
TODO: To get started, check out <http://site>!
## How to install
You may install this theme using Bower or Meteor:
- Bower : `bower install bootstrap-material-design`
- Meteor: `meteor add fezvrasta:bootstrap-material-design`
If you prefer, you can include this framework in your project using our official CDN:
- [Bootstrap Material Design on CDNJS.com](https://cdnjs.com/libraries/bootstrap-material-design)
- [Bootstrap Material Design on JSDelivr.com](http://www.jsdelivr.com/#!bootstrap.material-design)
## Getting started
Add the necessary links to your `<head` element for fonts
To embed Roboto into your web page, copy the code as the first element in the <head> of your HTML document.
```html
<!-- Material Design fonts -->
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Roboto:300,400,500,700" type="text/css">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<!-- Bootstrap Material Design -->
<link href="dist/css/bootstrap-material-design.css" rel="stylesheet">
```
TLDR; <http://site#starter-template>
## Support
If you like this project you may support it by donating via Gittip, starring this repository or reporting issues. All issues filed should be reduced to a [CodePen](http://codepen.io/rosskevin/pen/VvRgrN) test case where possible.
[![gittip](demo/imgs/gittip-button.jpg)](https://www.gratipay.com/FezVrasta/)
[![issues](demo/imgs/issues-button.jpg)](https://github.com/FezVrasta/bootstrap-material-design/issues)
[![gittip](docs/assets/img/gittip-button.jpg)](https://www.gratipay.com/FezVrasta/)
[![issues](docs/assets/img/issues-button.jpg)](https://github.com/FezVrasta/bootstrap-material-design/issues)
## Contributing
@ -57,29 +32,6 @@ Moreover, if your pull request contains JavaScript patches or features, you must
Editor preferences are available in the [editor config](https://github.com/FezVrasta/bootstrap-material-design/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
## Development
### Tools
We are using Grunt to automate the workflow and build process. Ensure you have `nodejs` installed and `grunt-cli`
and `bower` installed globally. After cloning the repo, run `npm install` to ensure you have all dev dependencies.
### SASS
The Bootstrap 4.x compatible version is developed using SASS.
The Bootstrap 3.x compatible version was developed using LESS, with an automated conversion to SASS.
TODO: The Bootstrap 3.x compatibile version is available as version 0.x.x
## Documentation
TODO: For customization and examples, please see the documentation (link)
[Material Design Specification](http://www.google.com/design/spec/material-design/introduction.html)
## Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under

4
docs/getting-started/introduction.md
View File

@ -55,6 +55,10 @@ Put it all together and your pages should look like this:
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<!-- Material Design fonts -->
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Roboto:300,400,500,700" type="text/css">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<!-- Material Design for Bootstrap CSS -->
<link rel="stylesheet" href="{{ site.cdn.css }}" integrity="{{ site.cdn.css_hash }}" crossorigin="anonymous">
</head>