|
3 | 3 | | Packages | Maven Central | Min Version | |
4 | 4 | |-----------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | |
5 | 5 | | posthog-android | [](https://maven-badges.herokuapp.com/sonatype-central/com.posthog/posthog-android) | Android API 21 | |
| 6 | +| posthog-android-surveys-compose | [](https://maven-badges.herokuapp.com/sonatype-central/com.posthog/posthog-android-surveys-compose) | Android API 23 · `0.x` | |
6 | 7 | | posthog (core) | [](https://maven-badges.herokuapp.com/sonatype-central/com.posthog/posthog) | Java 8 | |
7 | 8 | | posthog-server | [](https://maven-badges.herokuapp.com/sonatype-central/com.posthog/posthog-server) | Java 8 | |
8 | 9 | | posthog-android-gradle-plugin | [](https://maven-badges.herokuapp.com/sonatype-central/com.posthog/posthog-android-gradle-plugin) | Java 8 | |
9 | 10 |
|
10 | | -# PostHog Android & JVM SDKs |
| 11 | +# PostHog Android and JVM SDKs |
11 | 12 |
|
12 | 13 | This repository contains PostHog's Android and JVM SDKs. PostHog is an open source platform for product analytics, feature flags, session replay, and more. |
13 | 14 |
|
14 | | -## Packages |
15 | | - |
16 | | -### posthog-android |
17 | | - |
18 | | -Full-featured Android SDK with automatic screen tracking, session recording, and Android-specific features. |
19 | | - |
20 | | -```kotlin |
21 | | -implementation("com.posthog:posthog-android:$latestVersion") |
22 | | -``` |
23 | | - |
24 | | -**Documentation:** [posthog-android/](./posthog-android/) | **Usage:** [posthog-android/USAGE.md](./posthog-android/USAGE.md) |
25 | | - |
26 | | -### posthog (core) |
27 | | - |
28 | | -Pure Kotlin/JVM library suitable for environment specific SDK integrations. |
29 | | - |
30 | | -```kotlin |
31 | | -implementation("com.posthog:posthog:$latestVersion") |
32 | | -``` |
33 | | - |
34 | | -**Documentation:** [posthog/](./posthog/) | **Usage:** [posthog/USAGE.md](./posthog/USAGE.md) |
35 | | - |
36 | | -### posthog-server |
37 | | - |
38 | | -Pure Kotlin/JVM library suitable for server integrations. |
39 | | - |
40 | | -```kotlin |
41 | | -implementation("com.posthog:posthog-server:$latestVersion") |
42 | | -``` |
43 | | - |
44 | | -**Documentation:** [posthog-server/](./posthog-server/) | **Usage:** [posthog-server/USAGE.md](./posthog-server/USAGE.md) |
45 | | - |
46 | | -### posthog-android-gradle-plugin |
47 | | - |
48 | | -Gradle plugin suitable for Android-specific features. |
49 | | - |
50 | | -```kotlin |
51 | | -implementation("com.posthog:posthog-android-gradle-plugin:$latestVersion") |
52 | | -``` |
| 15 | +Please see the main [PostHog docs](https://posthog.com/docs). |
53 | 16 |
|
54 | | -**Documentation:** [posthog-android-gradle-plugin/](./posthog-android-gradle-plugin/) | **Usage:** [posthog-android-gradle-plugin/USAGE.md](./posthog-android-gradle-plugin/USAGE.md) |
| 17 | +SDK usage examples and code snippets live in the official documentation so they stay up to date. |
55 | 18 |
|
56 | 19 | ## Documentation |
57 | 20 |
|
58 | | -Please see the main [PostHog docs](https://posthog.com/docs). |
59 | | - |
60 | | -Specifically, the [Android docs](https://posthog.com/docs/libraries/android) details. |
| 21 | +- [Android library docs](https://posthog.com/docs/libraries/android) |
| 22 | +- [Java/JVM library docs](https://posthog.com/docs/libraries/java) |
61 | 23 |
|
62 | 24 | ## Questions? |
63 | 25 |
|
64 | 26 | ### [Check out our community page.](https://posthog.com/posts) |
| 27 | + |
| 28 | +## Contributing |
| 29 | + |
| 30 | +See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup and test instructions. |
0 commit comments