From 82dfef9102fe859f77bc839c31cec48838b8fe88 Mon Sep 17 00:00:00 2001
From: na2hiro <a@81.la>
Date: Thu, 2 May 2024 08:35:16 +0900
Subject: [PATCH] doc: Add about horizontal scroll to README (#6)

* Support horizontal scroll

* Update src/index.tsx

* Add about direction to README.md

---------

Co-authored-by: Kent C. Dodds <me+github@kentcdodds.com>
Co-authored-by: Kent C. Dodds <me@kentcdodds.com>
---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 0fe8efe..9226c83 100644
--- a/README.md
+++ b/README.md
@@ -74,6 +74,11 @@ And that's it! Now when the user navigates away from the page and then back to
 it, the list will be scrolled to the position it was at when the user left the
 page.
 
+You can also specify horizontal scroll for elements like carousels:
+
+```tsx
+<ElementScrollRestoration elementQuery="#christmas-gifts" direction="horizontal" />
+```
 ## Tips:
 
 1. This requires an inline script, so you'll need to pass a `nonce` if you're