summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan-Erik Rediger <janerik@fnordig.de>2022-06-27 09:52:43 +0200
committerJan-Erik Rediger <janerik@fnordig.de>2022-06-27 09:52:43 +0200
commitc7ad3bb975c428e61e79632edbad2e81dd437745 (patch)
treeaf18b87787a3825e05a3c4ef4e5ae3d1b709ea50
parenta0e7826551feb02870ea660f22eede6e8732c2d9 (diff)
Call out `git-branch` configuration
Introduced in 7e71fbb5. Closes #5 and #6
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9b8f84c..7b0ed7a 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,14 @@ Add a repository URL to use as a base in your `book.toml`:
git-repository-url = "https://github.com/mozilla/glean"
```
+By default it assumes the repository has a `main` branch.
+You can configure another branch using the `git-branch` option:
+
+```toml
+[output.html]
+git-branch = "trunk"
+```
+
To style the footer add a custom CSS file for your HTML output:
```toml