status-im/react-native-fs
2
0
Fork 0
mirror of https://github.com/status-im/react-native-fs.git synced 2025-02-28 06:50:37 +00:00
Code Issues Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Johannes Lumpe 2015-05-08 20:21:34 +03:00
parent 78f5272521
commit da94e2d794
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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`.