Skip to content

Commit

Permalink
docs(README.md): update package
Browse files Browse the repository at this point in the history
  • Loading branch information
ThibaultBee committed Jul 10, 2024
1 parent 031c518 commit bc75011
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Get srtdroid latest artifacts on MavenCentral.

```gradle
dependencies {
implementation 'io.github.thibaultbee:srtdroid:1.7.0'
implementation 'io.github.thibaultbee.srtdroid:srtdroid-core:1.7.0'
// If you use Kotlin Coroutines, you can use srtdroid-ktx
implementation 'io.github.thibaultbee.srtdroid:srtdroid-ktx:1.7.0'
}
```

Expand Down Expand Up @@ -44,20 +46,15 @@ can use the `InputStream` API.

## Permissions

You need to add the `INTERNET` permission in your AndroidManifest.xml:
To use, `sendFile` and `recvFile`, you need to add `READ_EXTERNAL_STORAGE` (or [`READ_MEDIA_*`](https://developer.android.com/about/versions/13/behavior-changes-13#granular-media-permissions) if your app targets Android 13 or higher)
and `WRITE_EXTERNAL_STORAGE` to your `AndroidManifest.xml`:

```xml

<uses-permission android:name="android.permission.INTERNET" />
```

To use, `sendFile` and `recvFile`, you might also need to add `READ_EXTERNAL_STORAGE`
and `WRITE_EXTERNAL_STORAGE`:

```xml

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /><uses-permission
android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<!-- If your app targets Android < 13 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<!-- If your app targets Android >= 13, READ_MEDIA_VIDEO and/or READ_MEDIA_IMAGES and/or READ_MEDIA_AUDIO -->
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />
```

Then, you have to request permissions at runtime.
Expand Down

0 comments on commit bc75011

Please sign in to comment.