Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 1.21 KB

README.md

File metadata and controls

17 lines (13 loc) · 1.21 KB
Raw

intro-guide-js

A JS library for creating a beautiful step-by-step introduction to your web application's functionality.

Here is a demo using ES2015 import syntax.

Dependencies

No jQuery, only PopperJS and FontAwesome. For latest update, check dependencies in package.json

Install

npm install --save intro-guide-js

How to

  1. Insert the CSS <link rel="stylesheet" href="./the-path/dist/css/bundle.css" />
  2. Create an empty div where the intro-guide's GUI elements can reside: <div id="intro" />
  3. Import the JS to your application:
  • Using ES2015 import syntax: Example.
  • Using traditional global include: Example. This also requires you to include the <script> which defines the global variable: <script src="./the-path/dist/js/bundle.js"></script>. Full HTML example here.