README.md in jekyll-material-theme-0.4.0 vs README.md in jekyll-material-theme-0.4.1
- old
+ new
@@ -2,10 +2,12 @@
A Jekyll Theme based on [Material Design](https://material.io/) using [Materialize](http://materializecss.com/).
[](https://badge.fury.io/rb/jekyll-material-theme)
+[](https://circleci.com/gh/jameshamann/jekyll-material-theme)
+
<a href="https://imgur.com/D9DSyuk"><img src="https://i.imgur.com/D9DSyuk.gif" title="source: imgur.com" /></a>
<a href="https://imgur.com/hlB1MOw"><img src="https://i.imgur.com/hlB1MOw.gif" title="source: imgur.com" /></a>
@@ -49,22 +51,26 @@
## Usage
The ```_config.yml``` file has the following options.
+Please ensure to copy this sample before serving up your site as some variables are required in order to make the site run correctly.
+
```yaml
title: Your awesome title
name: Your Name
email: your-email@example.com
description: Write an awesome description for your new site here. You can edit this line in _config.yml. It will appear in your document head meta (for Google search results) and in your feed.xml site description.
+theme: jekyll-material-theme
+
parallax_image_one: assets/images/startup3.jpg # These are the images used for the parallax background
parallax_image_two: assets/images/startup3.jpg
# Settings for the porfolio section
portfolio_heading: Portfolio
-portfolio_type: #cards or carousel
+portfolio_type: cards #cards or carousel
project_one: "First Project"
project_one_description: Describe your project!
project_one_url: https://github.com/jameshamann/jekyll-material-theme
project_one_icon: location_on # these are from materiailize css, the full collection is here: http://materializecss.com/icons.html