From 18cb12520589bc89971994e1ce00bd10b86db2fa Mon Sep 17 00:00:00 2001
From: Elnu <9874955+ElnuDev@users.noreply.github.com>
Date: Fri, 10 Jun 2022 20:30:58 -0700
Subject: [PATCH] Update README.md

---
 README.md | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5c5e7f5..2857820 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,25 @@
 # sakura-hugo-theme
 
-A minimal blog theme for Hugo using [Sakura](https://github.com/oxalorg/sakura) that uses no custom CSS.
+A minimal blog theme for Hugo using [Sakura](https://github.com/oxalorg/sakura) that uses no custom CSS. Supports furigana/ruby text `[振]{ふ}り[仮]{が}[名]{な}` markup out of the box.
 
 For an example of this theme in action, check out [my blog](https://blog.elnu.com/) ([repository](https://github.com/ElnuDev/blog.elnu.com))!
 
+If you're using Hugo's syntax highlighting and one of the light Sakura variants, it's recommended to use the `friendly` theme. To use it, add the following to your `config.toml`:
+
+```TOML
+[markup]
+	[markup.highlight]
+		style = 'friendly'
+```
+
 ## Parameters
 
-This theme supports some basic configuration options in addition to support for [Matomo analytics](https://matomo.org/) a FOSS and self-hosted analytics solution.
+This theme supports some basic configuration options in addition to support for [Matomo analytics](https://matomo.org/), a FOSS and self-hosted analytics solution.
 
+- `Author`: Author name for all posts. Required for proper post metadata.
+- `AuthorProfile`: URL to author profile, used for [Open Graph](https://ogp.me/).
+- `AuthorTwitter`: Author Twitter handle **without @**, used for Twitter cards.
+- `SiteTwitter`: Site Twitter handle (generally should be same as `AuthorTwitter`)
 - `Theme`: Variant of Sakura to use. If unspecified, will default to `sakura.css`. e.g `Theme = 'dark'` will use `sakura-dark.css`. Available variant themes:
   - `dark-solarized`
   - `dark`
@@ -15,6 +27,7 @@ This theme supports some basic configuration options in addition to support for
   - `ink`
   - `pink`
   - `vader`
+- `ThemeColor`: Theme color for embeds, etc. eg. `#000000`
 - `HomepageHeader`: Text displayed at the absolute top of the homepage, hidden on pagination. Can include HTML markup.
 - `MatomoURL`: URL of Matomo analytics server.
 - `MatomoSiteId`: Site ID of Matomo. **Must be string.**