Skip to content

Commit

Permalink
doc:update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Petterpx committed Oct 12, 2023
1 parent 33d908a commit 2a90e88
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 64 deletions.
35 changes: 4 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a9edd107b5444b7ca31738f5a96b3cb9)](https://app.codacy.com/gh/Petterpx/FloatingX?utm_source=github.com&utm_medium=referral&utm_content=Petterpx/FloatingX&utm_campaign=Badge_Grade_Settings)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.petterpx/floatingx)](https://search.maven.org/search?q=g:io.github.petterpx%20AND%20a:floatingx)
[![](https://jitpack.io/v/Petterpx/FloatingX.svg)](https://jitpack.io/#Petterpx/FloatingX) [![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)

**FloatingX** 一个灵活且强大的 `免权限` 悬浮窗解决方案。

[English Introduction](https://github.com/Petterpx/FloatingX/blob/main/README_EN.md)

[具体使用文档见这里](https://cskf7l0wab.feishu.cn/wiki/wikcnLLBCe3fIDUTAzrEg754tzc)

> **注意****1.3.4** 之后,仓库已迁移至[Maven](https://img.shields.io/maven-central/v/io.github.petterpx/floatingx),记得及时更新依赖方式。
## 👏 特性

- 支持 **自定义隐藏显示动画**;
Expand All @@ -30,40 +32,11 @@

## 👨‍💻‍ 依赖方式

### 添加jitpack仓库

**build.gradle**

Gradle7.0 以下

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

> AndroidStudio-Arctic Fox && Gradle7.0+,并且已经对依赖方式进行过调整,则可能需要添加到如下位置:
>
> **settings.gradle**
>
> ```groovy
> dependencyResolutionManagement {
> repositories {
>
> // ...
> maven { url 'https://jitpack.io' }
> }
> }
> ```
### Gradle

```groovy
dependencies {
implementation 'com.github.Petterpx:FloatingX:1.3.4'
implementation 'io.github.petterpx:floatingx:1.3.4'
}
```

Expand Down
40 changes: 7 additions & 33 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@



![image-20210810161316095](https://tva1.sinaimg.cn/large/008i3skNly1gwgttgkxlnj31040k840a.jpg)

[![](https://jitpack.io/v/Petterpx/FloatingX.svg)](https://jitpack.io/#Petterpx/FloatingX) [![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
![image-20210810161316095](https://tva1.sinaimg.cn/large/008i3skNly1gtbrg85hlhj61040k80ui02.jpg)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a9edd107b5444b7ca31738f5a96b3cb9)](https://app.codacy.com/gh/Petterpx/FloatingX?utm_source=github.com&utm_medium=referral&utm_content=Petterpx/FloatingX&utm_campaign=Badge_Grade_Settings)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.petterpx/floatingx)](https://search.maven.org/search?q=g:io.github.petterpx%20AND%20a:floatingx)
[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
**FloatingX** A flexible and powerful ``permission-free`` hover window solution.

> "Note: After version 1.3.4, the repository has been migrated to Maven. Make sure to update your dependency accordingly."
[中文简介](https://github.com/Petterpx/FloatingX/READDME.md)

[中午使用文档见这里](https://cskf7l0wab.feishu.cn/wiki/wikcnLLBCe3fIDUTAzrEg754tzc)
Expand All @@ -29,40 +32,11 @@

## 👨‍💻‍ Dependencies

### Add jitpack repository

**build.gradle**

Gradle 7.0 and below

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

> AndroidStudio-Arctic Fox && Gradle7.0+, and have adjusted the dependency method, you may need to add to the following location.
>
> **settings.gradle**
>
> ```groovy
> dependencyResolutionManagement {
> repositories {
>
> // ...
> maven { url 'https://jitpack.io' }
> }
> }
> ```
### Gradle

```groovy
dependencies {
implementation 'com.github.Petterpx:FloatingX:1.3.4'
implementation 'io.github.petterpx:floatingx:1.3.4'
}
```

Expand Down

0 comments on commit 2a90e88

Please sign in to comment.