aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-11-11 19:41:20 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-11-11 19:41:20 +0300
commit85e1f6fcdc9ed553fc2a3ac6b9d6d792599138fd (patch)
treebc405beb7d9d8d9b975d8ccc1d634b17c2d86af7 /README.md
parentfooter: shorten the "generated on" note (diff)
downloadjekyll-theme-85e1f6fcdc9ed553fc2a3ac6b9d6d792599138fd.tar.gz
jekyll-theme-85e1f6fcdc9ed553fc2a3ac6b9d6d792599138fd.zip
README: update
Diffstat (limited to '')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4ff81da..ac7be4a 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,22 @@ Preview
An example website can be viewed at https://egor-tensin.github.io/jekyll-theme/.
+Usage
+-----
+
+Use the `jekyll-remote-theme` plugin.
+Put this in your \_config.yml:
+
+```
+plugins:
+ - jekyll-remote-theme
+ # Other plugins...
+
+remote_theme: egor-tensin/jekyll-theme
+# Preferably, pin the exact commit:
+#remote_theme: egor-tensin/jekyll-theme@COMMIT_HASH
+```
+
Configuration
-------------