Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
caglarorhan committed Mar 10, 2024
1 parent 3b0009a commit 8637f2f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
**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)
4. [Usage](#usage)
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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/instructions.js
Original file line number Diff line number Diff line change
Expand Up @@ -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!"
},
Expand Down

0 comments on commit 8637f2f

Please sign in to comment.