Skip to content

Commit 2ccbbaa

Browse files
authored
Fix readme (#187)
1 parent 02cebf7 commit 2ccbbaa

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,7 @@
3838
- Swift 5.0+
3939

4040
### Android
41-
- macOS Proxyman app
42-
- Android API 26+ (Android 8.0 Oreo)
43-
- OkHttp 4.x or 5.x
44-
- Kotlin 1.9+
41+
- See [Atlantis Android](https://github.com/ProxymanApp/atlantis-android) for Android integration.
4542

4643
---
4744

@@ -485,6 +482,8 @@ Atlantis.start()
485482

486483
Atlantis for Android captures HTTP/HTTPS traffic from OkHttp (including Retrofit and Apollo) and sends it to Proxyman for debugging.
487484

485+
> Source code: [github.com/ProxymanApp/atlantis-android](https://github.com/ProxymanApp/atlantis-android)
486+
488487
## 1. Install Atlantis Android
489488

490489
### Gradle (Kotlin DSL)
@@ -524,7 +523,7 @@ dependencyResolutionManagement {
524523
Then add the dependency:
525524

526525
```kotlin
527-
debugImplementation("com.github.ProxymanApp:atlantis:1.0.0")
526+
debugImplementation("com.github.ProxymanApp:atlantis-android:1.0.0")
528527
```
529528

530529
## 2. Initialize Atlantis
@@ -609,9 +608,9 @@ Atlantis requires these permissions (automatically added by the library):
609608

610609
## Android Sample App
611610

612-
A sample Android app is included in `atlantis-android/sample/`. To run it:
611+
A sample Android app is included in the [atlantis-android](https://github.com/ProxymanApp/atlantis-android) repo. To run it:
613612

614-
1. Open `atlantis-android/` in Android Studio
613+
1. Clone [atlantis-android](https://github.com/ProxymanApp/atlantis-android) and open it in Android Studio
615614
2. Run the `sample` module
616615
3. Tap the buttons to make network requests
617616
4. View the traffic in Proxyman

0 commit comments

Comments
 (0)