docs: 更新部分版本信息、忽略配置

afkT · Jun 29, 2023 · 5360b6d · 5360b6d
1 parent 18822e5
commit 5360b6d
Show file tree

Hide file tree

Showing 3 changed files with 460 additions and 0 deletions.
diff --git a/API/README_API.md b/API/README_API.md
@@ -0,0 +1,229 @@
+
+<h1 align="center">DevUtils</h1>
+
+
+<p align="center">
+ <a href="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/afkT">
+  <img alt="Profile" src="https://img.shields.io/badge/GitHub-afkT-orange.svg" />
+ </a>
+ <a href="https://github.com/afkT/DevUtils/blob/master/LICENSE">
+  <img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" />
+ </a>
+ <a href="https://search.maven.org/search?q=io.github.afkt">
+  <img alt="Version" src="https://img.shields.io/badge/Maven-Dev-5776E0.svg" />
+ </a>
+ <a href="https://android-arsenal.com/api?level=14">
+  <img alt="API" src="https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat" />
+ </a>
+ <a href="https://search.maven.org/search?q=io.github.afkt">
+  <img alt="Version" src="https://img.shields.io/badge/DevUtils-2.4.2-yellow.svg" />
+ </a>
+ <a href="https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md">
+  <img alt="Utils" src="https://img.shields.io/badge/Utils-300+-critical.svg" />
+ </a>
+</p>
+
+
+<p align="center">
+ 🔥 ( 持续更新，目前含 300+ 工具类 ) <a href="https://github.com/afkT/DevUtils/projects/1">Roadmap</a>
+ <br>
+ DevUtils 是一个 Android 工具库，主要根据不同功能模块，封装快捷使用的工具类及 API 方法调用。
+ <br>
+ 该项目尽可能的便于开发人员，快捷、高效开发安全可靠的项目。
+</p>
+
+
+<p align="center">
+ <b>
+  <a href="https://github.com/afkT/DevUtils/blob/master/README/android_standard.md">Android 规范</a>
+ </b>、
+ <b>
+  <a href="https://github.com/afkT/DevUtils/blob/master/README/java_standard.md">Java 规范</a>
+ </b>、
+ <b>
+  <a href="https://github.com/afkT/DevUtils/blob/master/README/git_standard.md">Git 规范</a>
+ </b>
+</p>
+
+
+![module](https://github.com/afkT/DevUtils/raw/master/art/module.png)
+
+
+## Download
+
+下载 DevUtils 系列开发库演示应用 [APK](https://github.com/afkT/Resources/blob/main/APK)
+
+
+## Documentation - [Lib](https://github.com/afkT/DevUtils/blob/master/lib) **（ 全部已迁移至 Maven Central ）**
+
+### DevApp - Android 工具类库
+
+- [README - API](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md)
+
+- [Use and Config](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/utils_readme/USE_CONFIG.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/CHANGELOG.md)
+
+### DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
+
+- [README - API](https://github.com/afkT/DevUtils/blob/master/lib/DevAssist/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevAssist/CHANGELOG.md)
+
+### DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevBase/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevBase/CHANGELOG.md)
+
+### DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevBaseMVVM/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevBaseMVVM/CHANGELOG.md)
+
+### DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevEngine/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevEngine/CHANGELOG.md)
+
+### DevHttpCapture - OkHttp 抓包工具库
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/CHANGELOG.md)
+
+### DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md)
+
+### DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpManager/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpManager/CHANGELOG.md)
+
+### DevRetrofit - Retrofit + Kotlin Coroutines 封装
+
+- [README](https://github.com/afkT/DevUtils/blob/master/lib/DevRetrofit/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevRetrofit/CHANGELOG.md)
+
+### DevWidget - 自定义 View UI 库
+
+- [README - API](https://github.com/afkT/DevUtils/blob/master/lib/DevWidget/README.md)
+
+- [Preview README](https://github.com/afkT/DevUtils-repo/blob/main/lib/DevWidget_Preview.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevWidget/CHANGELOG.md)
+
+### DevEnvironment - Android 环境配置切换库
+
+- [README - API](https://github.com/afkT/DevUtils/blob/master/lib/Environment)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironment/CHANGELOG.md)
+
+### DevJava - Java 工具类库 ( 不依赖 android api )
+
+- [README - API](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/README.md)
+
+- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/CHANGELOG.md)
+
+
+## Other
+
+### DevComponent
+
+**[DevComponent](https://github.com/afkT/DevComponent)** 【100% Kotlin 实现 Android 项目组件化示例代码】
+基于 Android JetPack + Kotlin + Coroutines + MVVM 架构（DataBinding、ViewModel、Lifecycle）
+等最新技术栈进行组件化基础搭建，使用 ARouter 方案实现组件化
+
+### DevUtils-repo
+
+**[DevUtils-repo](https://github.com/afkT/DevUtils-repo)** 该项目是针对 [DevUtils](https://github.com/afkT/DevUtils) 第三方库封装扩展、新技术 Demo 编写、大文件资源等迁移存储仓库。
+
+减少 `DevUtils` 仓库大小方便快速 clone，并让 `DevUtils` 项目**更加纯粹**只保留 Dev 系列开发库相关代码。
+
+移除多余的第三方库、插件依赖配置，避免过多无关且繁杂配置影响快速理解项目，降低第三方库下载数量、编译运行 `DevUtils 演示 Demo App` 难度，使项目可更加快捷运行。
+
+### DevUtils API Generate
+
+[JavaDoc API Generate](https://github.com/afkT/JavaDoc) 该工具类 (DevUtils) API 文档，是通过 JavaDoc 项目读取 class 信息生成，
+并且进行代码、注释间距规范检测，生成效果示范 [DevApp - API](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md)
+
+### DevOther
+
+[DevOther](https://github.com/afkT/DevUtils-repo/blob/main/lib/LocalModules/DevOther)
+功能、工具类二次封装，直接 copy 使用【 大部分迁移至 DevUtils-repo 】
+
+### DevSKU
+
+[DevSKU](https://github.com/afkT/DevUtils/blob/master/lib/LocalModules/DevSKU/src/main/java/dev/sku/SKU.kt)
+商品 SKU 组合封装实现 ( 如何使用搜索 DevSKUActivity )
+
+
+## Dev 系列开发库全部 Lib Gradle
+
+```gradle
+
+// DevApp - Android 工具类库
+implementation 'io.github.afkt:DevAppX:2.4.2'
+
+// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
+implementation 'io.github.afkt:DevAssist:1.3.8'
+
+// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
+implementation 'io.github.afkt:DevBase:1.1.4'
+
+// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
+implementation 'io.github.afkt:DevBaseMVVM:1.1.2'
+
+// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
+implementation 'io.github.afkt:DevEngine:1.1.0'
+
+// DevHttpCapture - OkHttp 抓包工具库
+implementation 'io.github.afkt:DevHttpCapture:1.1.3'
+
+// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
+debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.3'
+releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.3'
+
+// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
+implementation 'io.github.afkt:DevHttpManager:1.0.3'
+
+// DevRetrofit - Retrofit + Kotlin Coroutines 封装
+implementation 'io.github.afkt:DevRetrofit:1.0.2'
+
+// DevWidget - 自定义 View UI 库
+implementation 'io.github.afkt:DevWidgetX:1.2.0'
+
+// DevEnvironment - Android 环境配置切换库
+implementation 'io.github.afkt:DevEnvironment:1.1.2'
+debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kaptDebug
+releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.2' // kaptRelease
+//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.2' // kapt
+
+// DevJava - Java 工具类库 ( 不依赖 android api )
+implementation 'io.github.afkt:DevJava:1.4.8' // 用于纯 Java 开发，如果依赖了 DevApp 则不需要依赖 DevJava
+```
+
+
+## License
+
+ Copyright 2018 afkT
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+  http:https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+