README.md in jekyll-material-theme-0.1.1 vs README.md in jekyll-material-theme-0.1.2
- old
+ new
@@ -21,26 +21,26 @@
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
-gem "material-theme"
+gem "jekyll-material-theme"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
-theme: material-theme
+theme: jekyll-material-theme
```
And then execute:
$ bundle
Or install it yourself as:
- $ gem install material-theme
+ $ gem install jekyll-material-theme
## Usage
The ```_config.yml``` file has the following options.
@@ -79,11 +79,11 @@
project_button: Github
github: https://github.com/jameshamann/jekyll-material-theme
medium: https://medium.com
-baseurl: / # If your site is located at /blog or /home, change it here
+baseurl: # If your site is located at /blog or /home, change it here, otherwise leave it empty
url: http://localhost:4000/ # The URL of your site
google_analytics_tracking_id: # This looks something like UA-000000000-0 Head over to https://analytics.google.com/ to setup.
cookie_accept_message: Thanks! # The pop-up dialog that appears after accepting the cookie notice.
@@ -104,9 +104,14 @@
Bug reports and pull requests are welcome on GitHub at https://github.com/jameshamann/jekyll-material-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop and further customise this theme, fork the repo and explore the ```_assets``` directory, which includes all the ```css, js``` and ```font``` folders.
+
+## Contributors
+
+- [James Hamann](https://github.com/jameshamann)
+- [Jam Rizzer](https://github.com/jamrizzi)
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).