Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Matej-ch committed May 13, 2022
1 parent 309d921 commit ce7d0ca
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 5 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ or add
"matejch/yii2-page-guide": "^1.0"
```

to the require section of your `composer.json` file.
to the requirement section of your `composer.json` file.

Setup
-----

#### 1. First migrate table

it is necessary for saving rules on pages
It is necessary for saving rules on pages

```php
./yii migrate --migrationPath=@vendor/matejch/yii2-page-guide/src/migrations
Expand All @@ -43,7 +43,7 @@ it is necessary for saving rules on pages

#### 3. Add widget on pages you want to use page guide on

By default it is rendered in place you put widget on
By default, it is rendered in place you put widget on

```php
<?= \matejch\pageGuide\widget\PageAssist::widget() ?>
Expand All @@ -56,13 +56,24 @@ If you want it to be positioned on right top side, use widget option **_'btnPosi

```

### 4. Additional intro options from intro.js library

If you want you can add intro.js option into widget with attribute `introOptions`

More options here [intro.js](https://introjs.com/docs/examples/customizing/html-tooltip)
```php
<?= \matejch\pageGuide\widget\PageAssist::widget(['introOptions' => ['showProgress' => true] ]) ?>

```

Usage
-----
Access index and form for creation of rules with

```php
{key_of_module_you_use_in_web.php}/page-guide/index
```

#### 1. Create new set of rules

Insert url on your yii web page into first input
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "matejch/yii2-page-guide",
"description": "Ability to add guide to pages for user orientation",
"type": "yii2-extension",
"version": "1.1.1",
"version": "1.2.0",
"keywords": ["yii2","extension","guide"],
"license": "MIT",
"authors": [
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "yii2-page-guide",
"version": "1.1.1",
"version": "1.2.0",
"description": "Page guide extension\r ====================\r Ability to add guide to pages for user orientation",
"main": "",
"scripts": {
Expand Down
Binary file modified readme/Contact with guide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified readme/Create page guide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce7d0ca

Please sign in to comment.