Browse Source

Update README.md

Gaëtan Renaudeau 7 years ago
parent
commit
eb163644f0
1 changed files with 2 additions and 2 deletions
  1. 2
    2
      README.md

+ 2
- 2
README.md View File

@@ -41,14 +41,14 @@ Returns a Promise of the image URI.
41 41
     - `"data-uri"`: same as `base64` but also includes the [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme) header.
42 42
  - **`filename`** *(string)*: the name of the generated file if any (Android only). Defaults to `ReactNative_snapshot_image_${timestamp}`.
43 43
 
44
-## Notes
44
+## Caveats
45 45
 
46 46
 Snapshots are not guaranteed to be pixel perfect. It also depends on the platform. Here is some difference we have noticed and how to workaround.
47 47
 
48 48
 - Support of special components like Video / GL views remains untested.
49 49
 - It's preferable to **use a background color on the view you rasterize** to avoid transparent pixels and potential weirdness that some border appear around texts.
50 50
 
51
-### Notes specific to Android implementation
51
+### specific to Android implementation
52 52
 
53 53
 - you need to make sure `collapsable` is set to `false` if you want to snapshot a **View**. Otherwise that view won't reflect any UI View. ([found by @gaguirre](https://github.com/gre/react-native-view-shot/issues/7#issuecomment-245302844))
54 54
 - if you want to share out the screenshoted file, you will have to copy it somewhere first so it's accessible to an Intent, see comment: https://github.com/gre/react-native-view-shot/issues/11#issuecomment-251080804 .