From feac2e0d716b19213c51bcf237a9afd9a2811fe2 Mon Sep 17 00:00:00 2001 From: Kevin Ross Date: Wed, 25 Nov 2015 16:12:12 -0600 Subject: [PATCH] shrink readme since the new docs have all the information (no need to have it in two places) --- README.md | 58 +++------------------------- docs/getting-started/introduction.md | 4 ++ 2 files changed, 9 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index de5635dc..476b0128 100644 --- a/README.md +++ b/README.md @@ -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 `` tag), and everything will be converted to Material Design (Paper) style. +the end of your document (just before the `` tag), and everything will be converted to Material Design. -TODO: docs/demo link +TODO: To get started, check out ! -## 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 ` of your HTML document. -```html - - - - - - -``` +TLDR; ## 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 . - -## 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 diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md index 148ac2b1..39a3ece7 100644 --- a/docs/getting-started/introduction.md +++ b/docs/getting-started/introduction.md @@ -55,6 +55,10 @@ Put it all together and your pages should look like this: + + + +