From da94e2d794fd2d903d7c7e0de64e26ff4c481db9 Mon Sep 17 00:00:00 2001 From: Johannes Lumpe Date: Fri, 8 May 2015 20:21:34 +0300 Subject: [PATCH] Updated readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d861ec0..368251a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Native filesystem access for react-native Note: this project is under development and functionality will improve over time. Currently it provides only the bare minimum of functionality. -Renaming, copying, and creating files will follow soon. +Creating, renaming, copying, etc. of files will follow soon. ## Usage @@ -55,6 +55,17 @@ RNFS.readDir('/', RNFS.MainBundle) ## API +### Constants + +The following constants are available on the `RNFS` export: + +`MainBundle` (`Number`) The identifier for the main bundle +`CachesDirectory` (`Number`) The identifier for the caches directory +`DocumentDirectory` (`Number`) The identifier for the document directory + +`CachesDirectoryPath` (`String`) The absolute path to the caches directory +`DocumentDirectoryPath` (`String`) The absolute path to the document directory + ### `promise readDir(path, directory)` Reads the contents of `path` in `directory`.