From 31741da867f0458e860d670dc14963e0494b5a1f Mon Sep 17 00:00:00 2001 From: Vitaliy Pashkov Date: Mon, 7 Aug 2017 08:17:28 +0700 Subject: [PATCH] readme --- readme.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 180d37b..3c9a641 100644 --- a/readme.md +++ b/readme.md @@ -10,10 +10,26 @@ Yii2 расширение для работы со структурами дан - Limit, offset, count работающие так как хочется - REST API -##Установка +Установка +-- +Установка с помощью [composer](http://getcomposer.org/download/). -##Использование +Выполните: +``` +php composer.phar require --prefer-dist vpashkov/yii2-represent +``` + +или добавьте + +```json +"vpashkov/yii2-represent": "~1.0.0" +``` + +в секцию require файла composer.json. + +Использование +-- Перед использованием, необходимо сгенерировать модели таблиц ActiveRecord @@ -71,8 +87,8 @@ GET /api/one?represent=user/edit POST /api/save?represent=user/edit POST /api/delete?represent=user/edit -## Represent API - +Represent API +-- | Scope | Method | Description | | --------| -------- | -------- | @@ -295,7 +311,8 @@ class View extends Represent После выборки словаря вызывается метод `processDICT_NAME($rows)` (где DICT_NAME = ucfirst(имя словаря)) если он определён. -## RepresentController API +RepresentController API +-- RepresentController реализует REST API для методов Represent. Для использования необходимо создать контроллер унаследованный от RepresentController.