aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index 998b9a3..4ff81da 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,7 @@ Put it in \_config.yml and adjust how you see fit.
settings:
project:
name: Test project
+ # The following settings are picked up from GitHub by default.
description: This is a test project
license: MIT License
license_file: LICENSE.txt
@@ -37,8 +38,8 @@ settings:
email: John.Doe@example.com
navbar:
hide: false
+ # Only relevant if the project's on GitHub.
github:
- # Only relevant if you use jekyll-github-metadata or github-pages
link: GitHub
icon: globe
```