Skip to content

README.md

Latest commit

 

History

History
70 lines (46 loc) · 1.9 KB

README.md

File metadata and controls

70 lines (46 loc) · 1.9 KB

web-tutorial-generator

License: MIT

About The Project

A library that aims to simplify the creation of a tutorial or first time experience of a website or web-app

(back to top)

Getting Started

For the moment there is no minify version so if you want to use this library just download the lib.js. The library expect that a variable with the name tutorialGeneratorConfig will be present.

Usage

  1. Download the lib.js file and import add it to your script import at the end of the body
<script src="js/lib.js"></script>
  1. Add a file tutorialGenerator-config.js and declare a tutorialGeneratorConfig variable
  2. Insert the tutorial-generator component in your page (without it the tutorial wont start)
<html>
  <head>
    <!-- Head stuff.. -->
  </head>
  <body>
    <!-- Body stuff.. -->
    <tutorial-generator></tutorial-generator>
  </body>
</html>

(back to top)

Roadmap

  • Add Changelog
  • Add minify version
  • Improve config file documentation
  • Add CSS class customizatin support
  • Add state saving for resuming an interrupted tutorial

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)