add bottomsheet readme

bottom-sheet/readme.md

@@ -0,0 +1,27 @@
+# BottomSheet Utils
+
+- `BaseBottomSheet` - класс, содержащий парамерты `BottomSheetOptions`
+
+- `DefaultBottomSheet` - класс с классическим хедером и скруглением, в котором нужно переопределить `createContentView()` 
+
+## BottomSheetOptions
+- `styleId` - xml-стиль, в котором можно задать скругление
+- `canDismiss` - может ли модалка быть срыта по тапу/свайпу/backButton
+- `canTouchOutside` - возможность передавать жесты под модалкой
+- `isSkipCollapsed` - убирает промежуточное состояние модалки
+- `isFullscreen` - модалка откроется на весь экран, даже при маленьком контенте
+- `isShiftedWithKeyboard` - модалка будет полностью подниматься при открытии клавиатуры
+- `defaultDimAmount` - константное затемнение
+- `animatedMaxDimAmount` - максимальное затемнение, при этом будет анимироваться в зависимости от offset
+- `fadeAnimationOptions` - позволяет настроить fade анимацию при изменении высоты
+- `heightStatesOptions` - позволяет задать 3 состояния высоты модалки
+
+## ContentFadeAnimationOptions
+- `foregroundRes` - drawableId, который будет показыватся сверху во время анимации
+- `duration` - длительность fade анимации
+- `minAlpha` - минимальная прозрачность во время анимации
+
+## HeightStatesOptions
+- `collapsedHeightPx` - высота минимального состояния
+- `halfExpandedHalfPx` - высота промежуточного состояния
+- `canTouchOutsideWhenCollapsed` - могут ли жесты передаватья под модалку в минимальном состоянии

bottom-sheet/src/main/java/ru/touchin/roboswag/bottomsheet/BottomSheetOptions.kt

@@ -3,6 +3,9 @@ package ru.touchin.roboswag.bottomsheet
 import androidx.annotation.DrawableRes
 import androidx.annotation.StyleRes
 
+/**
+ * See explanation in readme
+ * */
 data class BottomSheetOptions(
     @StyleRes val styleId: Int? = null,
     val canDismiss: Boolean = true,