Skip to content

Commit a95cd5e

Browse files
authored
Update README.md
1 parent 2299fb1 commit a95cd5e

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
1-
# lcwTourGuide
2-
Tour Guide Free JS plugin
1+
# 🧭 lcwTourGuide
2+
3+
`lcwTourGuide` is a lightweight, dependency-free JavaScript library for creating guided tours and onboarding experiences on your website.
4+
It highlights elements, shows tooltips, automatically positions them, and provides callback hooks for easy customization.
5+
6+
---
7+
8+
## ✨ Features
9+
- 🚀 Pure JavaScript, no dependencies
10+
- 🎯 Highlights target elements with an overlay
11+
- 📜 Scrolls automatically to show the highlighted element and tooltip
12+
- 🧩 Smart tooltip positioning (auto-adjusts above/below based on space)
13+
- 🔄 Step navigation (`Next`, `Previous`, `Done`)
14+
- ⚡ Callback hooks for `onStart`, `onStep`, `onEnd`
15+
- 🎨 Fully customizable with CSS
16+
17+
---
18+
19+
## 📦 Installation
20+
21+
Include the script and styles in your project:
22+
23+
```html
24+
<link rel="stylesheet" href="lcwTourGuide.css">
25+
<script src="lcwTourGuide.js"></script>

0 commit comments

Comments
 (0)