From 57af7faf88dae157945c1d336c98989dc7c45411 Mon Sep 17 00:00:00 2001 From: Mangala Sadhu Sangeet Singh Khalsa Date: Fri, 26 Feb 2021 10:20:35 -0700 Subject: [PATCH] README.md: clarify usage of readFileRes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bc09b9f1..476c1357 100644 --- a/README.md +++ b/README.md @@ -405,7 +405,7 @@ Note: Android only. ### `readFileRes(filename:string, encoding?: string): Promise` -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. +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. Note: Android only.