diff --git a/README.md b/README.md index bb672e6..903b8f6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ # jekyll-mdl -A Jekyll theme based in Google Material Design Lite library. +> A Jekyll theme based in Google Material Design Lite library. + +## Layout Configs +You can setup 4 types of layout + +- Fixed Nav + Simple Card Grid +- Drawer Nav + Simple Card Grid +- Fixed Nav + Highlight Post + Card Grid +- Drawer Nav + Highlight Post + Card Grid + +For use this in the [_config.yml](https://github.com/gdg-managua/jekyll-mdl/blob/master/_config.yml) select the type of layout, rebuild the website and voilà :smile: + +## Contributing +If you want to contribute to this project, please read the [CONTRIBUTING](https://github.com/gdg-managua/jekyll-mdl/blob/master/CONTRIBUTING.md) file and perform the following steps + + # Fork this repository + # Clone your fork + jekyll serve --watch + + git checkout -b feature_branch + # Implement your feature and tests + git add . && git commit + git push -u origin feature_branch + # Send a pull request for your feature branch + +## Team +[![Oscar Cortez](https://avatars3.githubusercontent.com/u/2553459?v=3&s=460)](http://github.com/oscarmcm) | [![Byron Corrales](https://avatars1.githubusercontent.com/u/99616?v=3&s=460)](https://github.com/byroncorrales) +---|--- +[Oscar Cortez](http://github.com/oscarmcm) | [Byron Corrales](https://github.com/byroncorrales) + +## License +Licensed under the Apache 2.0 license. + +See the [LICENSE](https://github.com/gdg-managua/jekyll-mdl/blob/master/LICENSE.md) file for more details. + +Copyright © 2015 [Google Developers Group Managua](http://www.gdgmanagua.org).