diff --git a/README.md b/README.md index 287ea4a..4455961 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,34 @@ -## spotlight-js -> Allows highlighting any element, adding feature introduction, adding hints +

Driver.js

-## Highlighting Single Elements +

+ + + + + + + + + +

-```javascript -const spotlight = new Spotlight({ - opacity: 0.7, // opacity for the background - padding: 5, // padding around the element -}); +

+ A powerful yet light-weight, vanilla JavaScript engine to drive the user's focus across the page
+ Only ~4kb, no external dependency, supports all major browsers and highly customizable +

-spotlight.highlight('#some-element'); -spotlight.clear(); -``` \ No newline at end of file +
+ +* **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) + +For Usage and Examples, [have a look at demo]() \ No newline at end of file diff --git a/demo/images/driver.png b/demo/images/driver.png new file mode 100644 index 0000000..5d2909e Binary files /dev/null and b/demo/images/driver.png differ diff --git a/demo/images/split.png b/demo/images/split.png new file mode 100644 index 0000000..ade9769 Binary files /dev/null and b/demo/images/split.png differ diff --git a/package.json b/package.json index 444a2bd..bf1519f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "driver.js", - "version": "1.0.0", - "description": "A light-weight, vanilla JS library to bring certain parts of page in spotlight", + "version": "0.1.0", + "description": "A light-weight, no-dependency, vanilla JavaScript library to drive the user's focus across the page", "main": "./assets/scripts/dist/driver.min.js", "scripts": { "start": "node server.js",