README.md in jekyll-theme-puzzleduck-0.1.0 vs README.md in jekyll-theme-puzzleduck-1.0.0
- old
+ new
@@ -2,11 +2,11 @@
This is the Jekyll theme for the PuZZleDucK.org blog.
[Theme preview](https://puzzleduck.github.io/jekyll-theme-puzzleduck/)
-
+
## Installation
Add this line to your Jekyll site's Gemfile:
@@ -27,26 +27,24 @@
Or install it yourself as:
$ gem install jekyll-theme-puzzleduck
-## About
+## Additional configuration
-Based on Minima.
+Configure additional links in _config.yml
+- linkedin_username
+- android_username
+- copyright_name
+- copyright_email
+- source_url
-## Usage
-TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
+## About
-## Development
+Based on Minima and using Materialize.
-To set up your environment to develop this theme, run `bundle install`.
-Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
-
-When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
-
## License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-