From 8637f2f84e72111e8407cda062fcc92da81aa8ce Mon Sep 17 00:00:00 2001 From: caglarorhan Date: Sat, 9 Mar 2024 21:56:28 -0600 Subject: [PATCH] readme updated --- README.md | 7 ++++--- src/instructions.js | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c354087..3548629 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ **Instructice: Creating Introductory Steps for Your Web App** # Instructice: Creating Interactive Demonstrations for Your Web App +- You can try it [here](https://caglarorhan.github.io/instructice/) -## Table of Contents +### Table of Contents 1. [General Info](#general-info) 2. [Technologies](#technologies) 3. [Installation](#installation) @@ -10,7 +11,7 @@ 5. [Contributing](#contributing) 6. [License](#license) -## General Info +### General Info Instructice is a library that allows you to create interactive demonstrations for any web application. It is still in development, so is still very immature. It enables you to guide users through your application with user actions like events and information tooltips. All data and options are configurable through the `instructions.js` file. ## Usage @@ -37,7 +38,7 @@ To use Instructice, you need to create an instructions.js file in your project. ### Contributing Contributions to Instructice are welcome. Feel free to fork the repository and submit a pull request. We also welcome any issues or suggestions for improvements. -## Issues +### Issues If you encounter any problems or have any suggestions for Instructice, please feel free to open an issue on our GitHub repository. We appreciate your feedback and will do our best to respond to your concerns in a timely manner. ### License diff --git a/src/instructions.js b/src/instructions.js index 64ab548..2e48ca4 100644 --- a/src/instructions.js +++ b/src/instructions.js @@ -6,7 +6,7 @@ let instructions = { id:"instructiceStarter", type:"img", class_name:"instructiceStarter", - value:"./img/instructions.svg", + value:"../img/instructions.svg", title:"Click to practice with instructions!", alt:"Click to practice with instructions!" },