Skip to content

Commit f76662a

Browse files
authored
Add README.md
Add README.md with project details and integration instructions
1 parent ab4f737 commit f76662a

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# libxposed API
2+
3+
[![API](https://img.shields.io/badge/API-101-brightgreen)](https://github.com/libxposed/api)
4+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.libxposed/api?color=blue)](https://central.sonatype.com/artifact/io.github.libxposed/api)
5+
[![Android Min SDK](https://img.shields.io/badge/minSdk-26-orange)](https://developer.android.com/about/versions/oreo)
6+
[![License](https://img.shields.io/github/license/libxposed/api)](LICENSE)
7+
8+
Modern Xposed Module API — a type-safe, redesigned replacement for the legacy XposedBridge API.
9+
10+
## Integration
11+
12+
```groovy
13+
dependencies {
14+
compileOnly "io.github.libxposed:api:101.0.0"
15+
}
16+
```
17+
18+
```kotlin
19+
dependencies {
20+
compileOnly("io.github.libxposed:api:101.0.0")
21+
}
22+
```
23+
24+
## Documentation
25+
26+
- [Guide](https://github.com/LSPosed/LSPosed/wiki/Develop-Xposed-Modules-Using-Modern-Xposed-API) — Getting started with the modern Xposed API
27+
- [Javadoc](api/src/main/java/io/github/libxposed/api/package-info.java) — Package-level API overview
28+
29+
## Related Projects
30+
31+
- [libxposed/helper](https://github.com/libxposed/helper) — Friendly development kit library
32+
- [libxposed/service](https://github.com/libxposed/service) — Framework communication service
33+
34+
## License
35+
36+
This project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)