Skip to content

Commit e2630ef

Browse files
committed
docs: 📝 reorganize README structure and update demo image size
1 parent d50f17f commit e2630ef

1 file changed

Lines changed: 11 additions & 23 deletions

File tree

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,24 @@
22

33
A lightweight React library to synchronize a vertical navigation menu with scrollable content sections. Ideal for advanced catalogs, filter drawers, and any layout that needs a **sticky nav** that tracks the **visible section** and enables **smooth scroll**.
44

5-
<p align="center">
6-
<a href="https://www.npmjs.com/package/@dorixdev/react-dual-scroll-sync">
7-
<img alt="npm version" src="https://img.shields.io/npm/v/@dorixdev/react-dual-scroll-sync?logo=npm&color=cb3837">
8-
</a>
9-
<a href="https://github.com/dorixdev/react-dual-scroll-sync/actions/workflows/release.yml">
10-
<img alt="build status" src="https://github.com/dorixdev/react-dual-scroll-sync/actions/workflows/release.yml/badge.svg?branch=main">
11-
</a>
12-
<a href="https://react-dual-scroll-sync.vercel.app">
13-
<img alt="docs" src="https://img.shields.io/badge/docs-Storybook-ff4785?logo=storybook">
14-
</a>
15-
<a href="https://bundlephobia.com/package/@dorixdev/react-dual-scroll-sync">
16-
<img alt="bundle size" src="https://img.shields.io/bundlephobia/minzip/@dorixdev/react-dual-scroll-sync?label=size&logo=webpack">
17-
</a>
18-
<a href="./LICENSE">
19-
<img alt="license" src="https://img.shields.io/badge/License-MIT-blue.svg">
20-
</a>
21-
</p>
22-
23-
<p align="center">
24-
<img alt="Demo" src="https://raw.githubusercontent.com/dorixdev/react-dual-scroll-sync/main/demo/preview.gif" width="720" />
25-
</p>
26-
27-
### 💡 Features
5+
[![npm version](https://img.shields.io/npm/v/@dorixdev/react-dual-scroll-sync?logo=npm&color=cb3837)](https://www.npmjs.com/package/@dorixdev/react-dual-scroll-sync)
6+
[![Release to npm](https://github.com/dorixdev/react-dual-scroll-sync/actions/workflows/release.yml/badge.svg)](https://github.com/dorixdev/react-dual-scroll-sync/actions/workflows/release.yml)
7+
[![docs](https://img.shields.io/badge/docs-Storybook-ff4785?logo=storybook)](https://react-dual-scroll-sync.vercel.app)
8+
[![bundle size](https://img.shields.io/bundlephobia/minzip/@dorixdev/react-dual-scroll-sync?label=size&logo=webpack)](https://bundlephobia.com/package/@dorixdev/react-dual-scroll-sync)
9+
[![license](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
10+
11+
## 💡 Features
2812

2913
- 🔗 **Sync state** between a vertical nav and the currently visible content section
3014
- 🧭 **Programmatic scroll** to a section when a menu item is selected
3115
-**Active item highlighting** and nav auto-scroll to keep it in view
3216
- 🎨 **Themable styles**: override CSS variables to match your design
3317
- 🧪 **Typed** (TypeScript) & framework-agnostic CSS
3418

19+
## 🎥 Demo
20+
21+
<img alt="Demo" src="https://raw.githubusercontent.com/dorixdev/react-dual-scroll-sync/main/demo/preview.gif" width="360" />
22+
3523
## 📦 Installation
3624

3725
```bash

0 commit comments

Comments
 (0)