From 7f91a1108fc824a94b4e16e56b8c39db177a067e Mon Sep 17 00:00:00 2001 From: FezVrasta Date: Mon, 1 Aug 2016 11:01:48 +0200 Subject: [PATCH] WIP version of README, will be used once v4 is released --- README-FINAL.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README-FINAL.md diff --git a/README-FINAL.md b/README-FINAL.md new file mode 100644 index 00000000..ff0ade5a --- /dev/null +++ b/README-FINAL.md @@ -0,0 +1,51 @@ +

Bootstrap Material Design

+ +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. + + +## Documentation + +NOTE: this is a temporary site location that will be published in at http://fezvrasta.github.io/bootstrap-material-design in the future. + +- [Getting Started](http://fezvrasta.github.io/bootstrap-material-design/getting-started/introduction/) +- [Building](http://fezvrasta.github.io/bootstrap-material-design/getting-started/building/) +- [Material Design components](http://fezvrasta.github.io/bootstrap-material-design/material-design/list-groups/) +- [Bootstrap default rendering reference documentation](http://fezvrasta.github.io/bootstrap-material-design/components/buttons/) +- [Migration](http://fezvrasta.github.io/bootstrap-material-design/migration/) + +## Support + +If you like this project you may support it by [donating](http://fezvrasta.github.io/bootstrap-material-design), starring this repository or reporting issues. +All issues filed should be reduced to a [CodePen](http://codepen.io/rosskevin/pen/eJMMVB) test case where possible. + + +## Contributing + +### Development +If you want to get involved, please do so by submitting pull requests. +Before undertaking any major PR effort, please check the [existing issues](https://github.com/FezVrasta/bootstrap-material-design/issues). +If there isn't one, please file a new issue so we can discuss and assign the work so effort is not duplicated. +Thank you! + +### Standard guidelines +Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. + +Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://codeguide.co/), maintained by [Mark Otto](https://github.com/mdo), one of Bootstrap's founders. + +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 . + + +## Versioning + +For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under +[the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible. + +See [the Releases section of our GitHub project](https://github.com/fezvrasta/bootstrap-material-design/releases) for changelogs +of each release version. + + +## License +[MIT License](LICENSE.md)