readme.md 1.8 KB
Newer Older
K
Kamran Ahmed 已提交
1
<h1 align="center"><img src="./demo/images/driver.png" /><br> Driver.js</h1>
2

K
Kamran Ahmed 已提交
3 4 5 6 7 8 9 10 11 12 13
<p align="center">
  <a href="https://creativecommons.org/licenses/by/4.0/">
    <img src="https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg" />
  </a>
  <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/contributions-welcome-green.svg" />
  </a>
  <a href="http://twitter.com/kamranahmedse">
    <img src="https://img.shields.io/badge/author-kamranahmedse-blue.svg" />
  </a>
</p>
14

K
Kamran Ahmed 已提交
15
<p align="center">
K
Kamran Ahmed 已提交
16
  <b>Powerful yet light-weight, vanilla JavaScript engine to drive the user's focus across the page</b></br>
K
Kamran Ahmed 已提交
17 18
  <sub>Only ~4kb, no external dependency, supports all major browsers and highly customizable <sub>
</p>
19

K
Kamran Ahmed 已提交
20 21 22 23 24 25 26 27 28 29 30 31 32 33
<br />

* **Simple**: is simple to use and has no external dependency at all
* **Light-weight**: ~4kb in size, vanilla JavaScript and no external dependency
* **Highly customizable**: has a powerful API and can be used however you want
* **Highlight anything**: highlight any (literally any) element on page
* **Feature introductions**: create powerful feature introductions and onboarding strategies
* **Focus shifters**: add focus shifters for users
* **User friendly**: Everything is controllable by keyboard
* **Consistent behavior**: usable across all browsers (including in-famous IE)
* **MIT Licensed**: free for personal and commercial use

![](./demo/images/split.png)

34 35 36 37
For Usage and Examples, [have a look at demo](http://kamranahmed.info/driver)

## Installation

K
Kamran Ahmed 已提交
38 39 40
You can install it using `yarn` or `npm`, whatever you prefer

```sh
41
yarn add driver.js
K
Kamran Ahmed 已提交
42
npm install driver.js
43 44
```

K
Kamran Ahmed 已提交
45
Or grab the code from `dist` directory and include it directly
46 47 48 49 50

```html
<link rel="stylesheet" href="/dist/driver.min.css">
<script src="/dist/driver.min.js"></script>
```