Add maven coordinates to README

saket · Mar 12, 2022 · 533b105 · 533b105
1 parent efa5e65
commit 533b105
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,11 @@
 
 https://user-images.githubusercontent.com/2387680/157795117-3a343625-4a34-4303-bb28-d2deea7f9b68.mp4
 
-`SwipeableActionsBox` is a composable that can be swiped left or right to reveal actions. Unlike [SwipeToDismiss](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#SwipeToDismiss(androidx.compose.material.DismissState,androidx.compose.ui.Modifier,kotlin.collections.Set,kotlin.Function1,kotlin.Function1,kotlin.Function1)), it is designed for swipe actions that _do not_ dismiss the composable.
+`swipe` builds composables that can be swiped left or right for revealing actions. Unlike [SwipeToDismiss](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#SwipeToDismiss(androidx.compose.material.DismissState,androidx.compose.ui.Modifier,kotlin.collections.Set,kotlin.Function1,kotlin.Function1,kotlin.Function1)), it is designed for swipe actions that _do not_ dismiss the composable.
+
+```groovy
+implementation "me.saket.swipe:swipe:1.0.0"
+```
 
 ```kotlin
 val archive = SwipeAction(

diff --git a/swipe/gradle.properties b/swipe/gradle.properties
@@ -5,7 +5,7 @@ VERSION_NAME=1.0.0
 POM_NAME=swipe
 POM_PACKAGING=aar
 
-POM_DESCRIPTION=A composable that can be swiped left or right to reveal actions.
+POM_DESCRIPTION=swipe builds composables that can be swiped left or right for revealing actions.
 POM_INCEPTION_YEAR=2022
 
 POM_URL=https://github.com/saket/swipe

diff --git a/swipe/src/main/kotlin/me/saket/swipe/SwipeableActionsBox.kt b/swipe/src/main/kotlin/me/saket/swipe/SwipeableActionsBox.kt
@@ -35,7 +35,7 @@ import kotlin.math.abs
 import kotlin.math.roundToInt
 
 /**
- * A composable that can be swiped left or right to reveal actions.
+ * A composable that can be swiped left or right for revealing actions.
  *
  * @param swipeThreshold Minimum drag distance before any [SwipeAction] is
  * activated and can be swiped.