diff --git a/README.md b/README.md index c09efc6..4086a73 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,72 @@

Документация к плагину

+ +
+ +

+

Как работать с этим плагином?

+
    +
  1. +Разметка для слайдера должна быть в следующем виде: + +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + +
    +
    + +
    + +Можно задать свои стили, но должно быть 2 отдельных стиля для вертикальной и горизонтальной ориентации - row и column соотвественно, чтобы изменив стиль на противоположный соотвественно изменился и вид.
    +Или же можно использовать готовые стили из файла "SliderPlugin.css" и использовать их надо следующим образом: + +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + +
    +
    +
  2. +
  3. +С подключенным файлом "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
    +} +
  4. +
+ +

+
+

Архитектура

Архитектура проекта состоит из 3 основных компонентов: Контроллер, Представление и Модель.