Skip to content

Commit b99a8d1

Browse files
authored
add a disclaimer in usage of dirs
1 parent 7af88da commit b99a8d1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Returns a Promise of the image URI.
4848

4949
By default, takeSnapshot will export in a temporary folder and the snapshot file will be deleted as soon as the app leaves. If you use the `path` option, you make the snapshot file more permanent and at a specific file location. To make file location more 'universal', the library exports some classic directory constants:
5050

51+
> If you use `dirs`, you own the file and manage its lifecycle: it won't get cleaned so be careful not leaking files on user's phone.
52+
5153
```js
5254
import { takeSnapshot, dirs } from "react-native-view-shot";
5355
// cross platform dirs:

0 commit comments

Comments
 (0)