From 49c2fac690e2aeab356badfcce0f577d46794c51 Mon Sep 17 00:00:00 2001 From: drake Date: Sun, 15 Dec 2024 13:50:27 +0800 Subject: [PATCH] docs: README --- README.md | 4 +-- README_EN.md | 76 +++++++++++++++++++++++++--------------------------- 2 files changed, 38 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 2faa1f0b..f702de8d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- 中文 + 中文 | English

@@ -36,8 +36,6 @@ BRV为快速构建RV列表工具, 以开源分享来完善, 将一直保持社区维护 -Welcome to international translation of this project's documents/notes, thank you for your support! -

欢迎贡献代码/问题


diff --git a/README_EN.md b/README_EN.md index 91960d96..945bdd2a 100644 --- a/README_EN.md +++ b/README_EN.md @@ -1,18 +1,18 @@ -

+

中文 | English

-

1600

+

1600

- Probably the most powerful RecyclerView framework + Possibly the Most Powerful RecyclerView Framework

- Documentation - | Can't Access? - | Contribute Code - | Download Demo App + Documentation + | Access Issues? + | Contribute + | Download Demo

@@ -22,60 +22,58 @@

- - - + + +

-

-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.
-

Contribute Code / Report Issues

+ +

Contributions Welcome


-- [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
## 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 { // ... @@ -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 {