Skip to content

Commit

Permalink
Updated README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
rllyhz committed Oct 31, 2022
1 parent 3b970fe commit ba8f315
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
# Pull To Refresh for Jetpack Compose

A library provides a layout to the pull-to-refresh UX Pattern.
This project is inspired by one of Google extension libraries for Jetpack Compose, called [SwipeRefresh](https://google.github.io/accompanist/swiperefresh/).
The concept of scrolling the content are absolutely the same. However, instead of showing just a progressbar indicator from the top to the bottom while the
content itself being scrolled down, the layout would show an additional customizable layouts that correspond to the refresh state. This layout could be an indicator,
an animation, or just text to show. It's totally customizable.
A library provides a layout to the pull-to-refresh UX Pattern. This project is inspired by one of
Google extension libraries for Jetpack Compose,
called [SwipeRefresh](https://google.github.io/accompanist/swiperefresh/). The concept of scrolling
the content are absolutely the same. However, instead of showing just a progressbar indicator from
the top to the bottom while the content itself being scrolled down, the layout would show an
additional customizable layouts that correspond to the refresh state. This layout could be an
indicator, an animation, or just text to show. It's totally customizable.

## Download

**Step 1.** Add the JitPack repository to your build file

```gradle
repositories {
...
maven { url 'https://jitpack.io' }
}
```

**Step 2.** Add the dependency

```gradle
dependencies {
implementation 'com.github.rllyhz:pullrefresh-compose:<version>'
}
```

0 comments on commit ba8f315

Please sign in to comment.