diff --git a/README.md b/README.md
index c09efc6..4086a73 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,72 @@
Документация к плагину
+
+
+
+
+
Как работать с этим плагином?
+
+-
+Разметка для слайдера должна быть в следующем виде:
+
+
+
+Можно задать свои стили, но должно быть 2 отдельных стиля для вертикальной и горизонтальной ориентации - row и column соотвественно, чтобы изменив стиль на противоположный соотвественно изменился и вид.
+Или же можно использовать готовые стили из файла "SliderPlugin.css" и использовать их надо следующим образом:
+
+
+
+
+
+
+
+
+
+
+
-
+С подключенным файлом "jQuery.js" и "SliderPlugin.js", выбрать слайдер с помощью jQuery функции $, вызвать у него функцию "AnimateSlider" и передать в нее объект с параметрами, которые надо установить. Вот список возможны параметров и значений:
+{
+ min: *целое число*,
+ max: *целое число*,
+ step: *целое число больше 0*,
+ startingPoint: *целое число*,
+ orientation: "row" или "column",
+ color: *цвет в HEX коде*,
+ hint: true или false,
+ hud: true или false,
+ interval: *целое число больше 0*,
+ track: true или false
+}
+
+
+
+
+
+Архитектура
Архитектура проекта состоит из 3 основных компонентов: Контроллер, Представление и Модель.
- Контроллер SliderController занимается обработкой событий и связывает представление и модель.
@@ -40,13 +106,13 @@
Модель
Модель отвечает за параметры слайдера: позиция, шаг, цвет, ориентация; и промежуточные значения для рассчетов.
-Конструктор принимает json объект с параметрами слайдера.
+Конструктор принимает объект с параметрами слайдера.
Задается метод "setStep" для установления нового значения шага.
-Задается метод "getModelData", который возращает данные в виде json объекта для вычисления позиции слайдера при взаимодействии с ним.
+Задается метод "getModelData", который возращает данные в виде объекта для вычисления позиции слайдера при взаимодействии с ним.
-Задается метод "getHudSettings", который возращает данные в виде json объекта для изменения подписи оси.
+Задается метод "getHudSettings", который возращает данные в виде объекта для изменения подписи оси.
Задается метод "get" для получения значений из модели.
@@ -63,7 +129,7 @@
Задаются обработчики события нажатия на мышь, передвижение мыши, отжатие мыши и отведение мышки от слайдера.
-Задается метод "set" для изменения параметров слайдера на принятые значения в виде json объекта вида {параметр: значение} и сами функции для установки параметров слайдера (ориентация, цвет и т.д.). Если параметр существует, то выполняется установленный у элемента обраотчик "onChangingParameters", куда передается объект:
+Задается метод "set" для изменения параметров слайдера на принятые значения в виде объекта вида {параметр: значение} и сами функции для установки параметров слайдера (ориентация, цвет и т.д.). Если параметр существует, то выполняется установленный у элемента обраотчик "onChangingParameters", куда передается объект:
{
parameter: \*название параметра\*,
parameterIndex: \*номер параметра по списку\*,
@@ -76,7 +142,7 @@
Функция подключения плагина к элементу
-Функция AnimateSlider вызывается у элементов jQuery найденных с помощью функции $. AnimateSlider принимает json объект с параметрами слайдера:
+Функция AnimateSlider вызывается у элементов jQuery найденных с помощью функции $. AnimateSlider принимает объект с параметрами слайдера:
- min (целое натуральное число) - минимальное значение слайдера;
- max (целое натуральное число) - максимальное значение;
@@ -89,7 +155,7 @@
- interval (целое натуральное число) - количество чисел для подписи оси;
- track (true || false) - показывать или не показывать след за бегунком соотвественно.
-Если какое-то значение не установленно то будет установленно значение по умолчанию соотвествующие следующему json объекту:
+Если какое-то значение не установленно то будет установленно значение по умолчанию соотвествующие следующему объекту:
{
min: 0,
max: 100,