From 53290beed2e2d63d3668fdc155e349572f4d90f9 Mon Sep 17 00:00:00 2001 From: b2a3e8 <31370519+b2a3e8@users.noreply.github.com> Date: Wed, 22 Jan 2020 01:00:26 +0100 Subject: [PATCH] Update documentation --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cbebcd88c..78a97c13a 100644 --- a/README.md +++ b/README.md @@ -13,25 +13,43 @@ source code: [https://github.com/b2a3e8/jekyll-theme-console/tree/gh-pages](http ## Installation -Add this line to your Jekyll site's `Gemfile`: +First, follow the steps in [this Quickstart Guide](https://jekyllrb.com/docs/) if you're starting with Jekyll from scratch. Skip this if you already have an existing jekyll project. -```ruby -gem "jekyll-theme-console" -``` +### Remote theme method for GitHub Pages -And add this line to your Jekyll site's `_config.yml`: +Use this method for sites hosted with GitHub Pages only. To install: -```yaml -theme: jekyll-theme-console -``` +1. Set `remote_theme` in your project's Jekyll `_config.yml` file: + + ```yaml + remote_theme: b2a3e8/jekyll-theme-console + ``` + +### Gem-based method + +With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process. + +This allows for easier installation and updating as you don't have to manage any of the theme files. To install: -And then execute: +1. Add this line to your Jekyll site's `Gemfile`: + + ```ruby + gem "jekyll-theme-console" + ``` - $ bundle +2. Fetch and update bundled gems by running the following [Bundler](http://bundler.io/) command: -Or install it yourself as: + ```bash + bundle + ``` - $ gem install jekyll-theme-console +3. Set `theme` in your project's Jekyll `_config.yml` file: + + ```yaml + theme: jekyll-theme-console + ``` + +To update the theme run `bundle update`. ## Usage