diff --git a/README.md b/README.md index 16b6ab267b808397e03aca139cefad5bc8c6b1a2..019a7415523b69773cef93a8096bb70ec84567d3 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,17 @@ ## Installation +### via GitHub Pages remote theme + +The quickiest way to use Just The Docs is to use GitHub pages [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) feature in your `config.yml` file: + +```yaml +remote_theme: just-the-docs/just-the-docs +``` +### via RubyGems: + +Alternatively you can install it as a Ruby Gem. + Add this line to your Jekyll site's Gemfile: ```ruby