Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
liangjingkanji committed Dec 15, 2024
1 parent 970616b commit 49c2fac
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 42 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p >
<a href="http://liangjingkanji.github.io/BRV/">中文</a>
<a href="https://github.com/liangjingkanji/BRV/">中文</a>
| <a href="https://github.com/liangjingkanji/BRV/blob/master/README_EN.md">English</a>
</p>

Expand Down Expand Up @@ -36,8 +36,6 @@

BRV为快速构建RV列表工具, 以开源分享来完善, 将一直保持社区维护

Welcome to international translation of this project's documents/notes, thank you for your support!

<br>
<p align="center"><strong>欢迎贡献代码/问题</strong></p>
<br>
Expand Down
76 changes: 37 additions & 39 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<p >
<p>
<a href="http://liangjingkanji.github.io/BRV/">中文</a>
| <a href="https://github.com/liangjingkanji/BRV/blob/master/README_EN.md">English</a>
</p>

<p align="center"><img src="https://i.imgur.com/S0IjjHS.jpg" alt="1600" width="25%"/></p>
<p align="center"><img src="https://github.com/liangjingkanji/BRV/assets/21078112/443d47ef-5dc7-49a3-bab2-6a9feb678aa1" alt="1600" width="25%"/></p>

<p align="center">
<strong>Probably the most powerful RecyclerView framework</strong>
<strong>Possibly the Most Powerful RecyclerView Framework</strong>
<br>
<br>
<a href="https://shenbengit.github.io/BRV/">Documentation</a>
| <a href="https://github.com/liangjingkanji/document/blob/master/visit-pages.md">Can't Access?</a>
| <a href="https://liangjingkanji.github.io/document/">Contribute Code</a>
| <a href="https://github.com/liangjingkanji/BRV/releases/latest/download/brv-sample.apk">Download Demo App</a>
<a href="http://liangjingkanji.github.io/BRV/">Documentation</a>
| <a href="https://github.com/liangjingkanji/document/blob/master/visit-pages.md">Access Issues?</a>
| <a href="https://liangjingkanji.github.io/document/">Contribute</a>
| <a href="https://github.com/liangjingkanji/BRV/releases/latest/download/brv-sample.apk">Download Demo</a>
<br>
<img src="https://github.com/liangjingkanji/BRV/blob/master/docs/img/code-preview.png?raw=true" width="300"/>
</p>
Expand All @@ -22,60 +22,58 @@
<p align="center">
<a href="https://jitpack.io/#liangjingkanji/BRV"><img src="https://jitpack.io/v/liangjingkanji/BRV.svg"/></a>
<img src="https://img.shields.io/badge/language-kotlin-orange.svg"/>
<img src="https://img.shields.io/badge/license-Apache-blue"/>
<a href="http://liangjingkanji.github.io/BRV/updates"><img src="https://img.shields.io/badge/changed-%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97-brightgreen"/></a>
<a href="http://liangjingkanji.github.io/BRV/api"><img src="https://img.shields.io/badge/api-%E5%87%BD%E6%95%B0%E6%96%87%E6%A1%A3-red"/></a>
<img src="https://img.shields.io/badge/license-MIT-blue"/>
<a href="http://liangjingkanji.github.io/BRV/updates"><img src="https://img.shields.io/badge/changed-Changelog-brightgreen"/></a>
<a href="http://liangjingkanji.github.io/BRV/api"><img src="https://img.shields.io/badge/api-Documentation-red"/></a>
<a href="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group-qrcode.png"><img src="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group.svg"/></a>
<a href="https://github.com/liangjingkanji/BRV/blob/master/docs/issues.md"><img src="https://raw.githubusercontent.com/liangjingkanji/Net/master/docs/img/issues.svg"/></a>
</p>


<p align="center"><img src="https://github.com/liangjingkanji/BRV/blob/master/docs/img/preview.png?raw=true" align="center" width="30%;" /></p>

BRV is a tool for quickly building an RV list, perfected by open source sharing, and will always be maintained by the community
BRV is a tool for quickly building RecyclerView lists, improved through open source sharing, and will always maintain community maintenance.

<br>
<p align="center"><strong>Contribute Code / Report Issues</strong></p>

<p align="center"><strong>Contributions Welcome</strong></p>
<br>

- [x] Development efficiency No.1
- [x] Maintained by the community forever
- [x] Low code/high extensibility
- [x] Excellent source code/comments/documentation/examples
- [x] #1 in Development Efficiency
- [x] Continuous Community Maintenance
- [x] Low Code / High Extensibility
- [x] Excellent Source Code / Comments / Documentation / Examples

<br>

## Features

- [x] Quickly create multi-type lists
- [x] Quick creation of multi-type lists
- [x] One-to-one/one-to-many multi-type creation
- [x] Add header and footer views
- [x] Add header and footer layouts
- [x] Click (debounce)/long press events
- [x] Grouping (expand/collapse/recursively/nested/expand and stick/top/ drag and swipe/multi-type/single expand mode)
- [x] Sticky header
- [x] Quickly create dividers/spaces
- [x] Switch mode (e.g., switch to edit mode)


- [x] Selection mode (multi-select/single-select/select all/deselect all/invert selection)
- [x] Grouping (expand/collapse/recursive/expand to top/drag/swipe/multi-type/single expand mode)
- [x] Sticky headers
- [x] Quick creation of dividers/spacing
- [x] Toggle modes (e.g., edit mode)
- [x] Selection mode (multi-select/single-select/select all/deselect all/inverse selection)
- [x] Drag and drop sorting
- [x] Swipe to delete
- [x] Pull-down refresh (Refresh) | Pull-up load more (LoadMore) | Pull-down load more (UpFetch), implemented by [SmartRefreshLayout](https://github.com/scwang90/SmartRefreshLayout)
- [x] Preload
- [x] Data update with diffing
- [x] Automatic pagination loading
- [x] List animation/skeleton animation
- [x] List empty state, implemented by [StateLayout](https://github.com/liangjingkanji/StateLayout)
- [x] Support DataBinding
- [x] Support ViewBinding
- [x] Add [FlexboxLayoutManager](https://github.com/google/flexbox-layout) to automatically wrap flexbox layout
- [x] Add [Net](https://github.com/liangjingkanji/Net) (powerful coroutine network request) to automate network requests
- [x] Pull to refresh | Load more | Up fetch ([SmartRefreshLayout](https://github.com/scwang90/SmartRefreshLayout))
- [x] Preloading
- [x] Data diff updates
- [x] Automatic pagination
- [x] List animations/skeleton loading
- [x] List placeholder pages ([StateLayout](https://github.com/liangjingkanji/StateLayout))
- [x] DataBinding support
- [x] ViewBinding support
- [x] Support for [FlexboxLayoutManager](https://github.com/google/flexbox-layout)
- [x] Can add [Net](https://github.com/liangjingkanji/Net) for automated network requests

## Installation

Add the remote repository to the root build.gradle file
Add repository to Project's settings.gradle

```groovy
```kotlin
dependencyResolutionManagement {
repositories {
// ...
Expand All @@ -84,7 +82,7 @@ dependencyResolutionManagement {
}
```

Then, add the framework dependency to the module's build.gradle file:
Add dependency to Module's build.gradle

```groovy
dependencies {
Expand Down

0 comments on commit 49c2fac

Please sign in to comment.