Skip to content

Commit 4ecb0fc

Browse files
authored
Merge pull request #985 from msssk/patch-1
README.md: clarify usage of readFileRes
2 parents 55bc86b + 57af7fa commit 4ecb0fc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ Note: Android only.
405405

406406
### `readFileRes(filename:string, encoding?: string): Promise<string>`
407407

408-
Reads the file named `filename` in the Android app's res folder and return contents. `res/drawable` is used as the parent folder for image files, `res/raw` for everything else. `encoding` can be one of `utf8` (default), `ascii`, `base64`. Use `base64` for reading binary files.
408+
Reads the file named `filename` in the Android app's `res` folder and return contents. Only the file name (not folder) needs to be specified. The file type will be detected from the extension and automatically located within `res/drawable` (for image files) or `res/raw` (for everything else). `encoding` can be one of `utf8` (default), `ascii`, `base64`. Use `base64` for reading binary files.
409409

410410
Note: Android only.
411411

0 commit comments

Comments
 (0)