Skip to content

Commit f1e4a27

Browse files
committed
docs: update README
1 parent 817575e commit f1e4a27

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,26 @@ yarn add @lodev09/react-native-exify
2121

2222
## Usage
2323

24-
```ts
24+
```tsx
2525
import * as Exify from '@lodev09/react-native-exify';
2626
```
2727

28-
### Reading Exif
28+
### Reading Exif 🔍
2929

30-
```ts
30+
```tsx
3131
const uri = 'file://path/to/image.jpg'
3232

3333
const tags = await Exify.read(uri)
3434
console.log(tags)
3535
```
3636

37-
> **Note:** On Android 10+, GPS data is redacted from `content://` URIs by default. The library automatically requests `ACCESS_MEDIA_LOCATION` at runtime to access unredacted location data. Your app must have media read access (`READ_MEDIA_IMAGES` or `READ_EXTERNAL_STORAGE`) granted first. If you're already using a library like [`expo-media-library`](https://docs.expo.dev/versions/latest/sdk/media-library/) that grants `ACCESS_MEDIA_LOCATION`, exify will use the existing grant.
37+
> [!NOTE]
38+
> On Android 10+, GPS data is redacted from `content://` URIs by default. The library automatically requests `ACCESS_MEDIA_LOCATION` at runtime to access unredacted location data. Your app must have media read access (`READ_MEDIA_IMAGES` or `READ_EXTERNAL_STORAGE`) granted first.
39+
> If you're already using a library like [`expo-media-library`](https://docs.expo.dev/versions/latest/sdk/media-library/) that grants `ACCESS_MEDIA_LOCATION`, exify will use the existing grant.
3840
39-
### Writing Exif
41+
### Writing Exif ✍️
4042

41-
```ts
43+
```tsx
4244
import type { ExifTags } from '@lodev09/react-native-exify';
4345

4446
const uri = 'file://path/to/image.jpg'
@@ -52,9 +54,12 @@ const result = await Exify.write(uri, newTags)
5254
console.log(result.tags)
5355
```
5456

55-
> **Note:** On iOS, writing exif into an Asset file will duplicate the image. iOS does not allow writing exif into an Asset file directly.
57+
> [!NOTE]
58+
> On iOS, writing exif into an Asset file will duplicate the image. iOS does not allow writing exif into an Asset file directly.
5659
> If you're getting the photo from a [camera](https://docs.expo.dev/versions/latest/sdk/camera/), write it into the output file first before saving to the Asset library!
5760
61+
## Example
62+
5863
See [example](example) for more detailed usage.
5964

6065
## Contributing

0 commit comments

Comments
 (0)