Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hiqsol committed Apr 20, 2017
1 parent 7ddd008 commit 6ce0fdf
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .hidev/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,12 @@ package:
title: Yandex.Metrika counter for Yii2 applications
headline: Yii2 Yandex.Metrika
keywords: yii2, yandex, metrika
description: |
Provides really easy adding [Yandex.Metrika] counter to site.
Even easier then adding a widget into site layout.
Works by adding Behavior to the Application View.
Behavior listens to [EVENT_END_BODY] and echos the counter script.
[Yandex.Metrika]: https://metrika.yandex.ru
[EVENT_END_BODY]: http://www.yiiframework.com/doc-2.0/yii-web-view.html#EVENT_END_BODY-detail
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/hiqdev/yii2-yandex-metrika.svg)](https://scrutinizer-ci.com/g/hiqdev/yii2-yandex-metrika/)
[![Dependency Status](https://www.versioneye.com/php/hiqdev:yii2-yandex-metrika/dev-master/badge.svg)](https://www.versioneye.com/php/hiqdev:yii2-yandex-metrika/dev-master)

Provides really easy adding [Yandex.Metrika] counter to site.
Even easier then adding a widget into site layout.

Works by adding Behavior to the Application View.
Behavior listens to [EVENT_END_BODY] and echos the counter script.

[Yandex.Metrika]: https://metrika.yandex.ru
[EVENT_END_BODY]: http://www.yiiframework.com/doc-2.0/yii-web-view.html#EVENT_END_BODY-detail

## Installation

The preferred way to install this yii2-extension is through [composer](http://getcomposer.org/download/).
Expand All @@ -27,6 +36,23 @@ or add

to the require section of your composer.json.

## Configuration

This extension is supposed to be used with [composer-config-plugin].

Else look [src/config/hisite.php] for cofiguration example.

Available configuration parameters:

- `yandexMetrika.id`
- `yandexMetrika.params`

For more details please see [src/config/params.php].

[composer-config-plugin]: https://github.com/hiqdev/composer-config-plugin
[src/config/hisite.php]: src/config/hisite.php
[src/config/params.php]: src/config/params.php

## License

This project is released under the terms of the BSD-3-Clause [license](LICENSE).
Expand Down
14 changes: 14 additions & 0 deletions docs/readme/Configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
This extension is supposed to be used with [composer-config-plugin].

Else look [src/config/hisite.php] for cofiguration example.

Available configuration parameters:

- `yandexMetrika.id`
- `yandexMetrika.params`

For more details please see [src/config/params.php].

[composer-config-plugin]: https://github.com/hiqdev/composer-config-plugin
[src/config/hisite.php]: src/config/hisite.php
[src/config/params.php]: src/config/params.php

0 comments on commit 6ce0fdf

Please sign in to comment.