Skip to content

Commit da94e2d

Browse files
committed
Updated readme
1 parent 78f5272 commit da94e2d

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Native filesystem access for react-native
44

55
Note: this project is under development and functionality will improve over time. Currently it provides only the bare minimum of functionality.
66

7-
Renaming, copying, and creating files will follow soon.
7+
Creating, renaming, copying, etc. of files will follow soon.
88

99
## Usage
1010

@@ -55,6 +55,17 @@ RNFS.readDir('/', RNFS.MainBundle)
5555

5656
## API
5757

58+
### Constants
59+
60+
The following constants are available on the `RNFS` export:
61+
62+
`MainBundle` (`Number`) The identifier for the main bundle
63+
`CachesDirectory` (`Number`) The identifier for the caches directory
64+
`DocumentDirectory` (`Number`) The identifier for the document directory
65+
66+
`CachesDirectoryPath` (`String`) The absolute path to the caches directory
67+
`DocumentDirectoryPath` (`String`) The absolute path to the document directory
68+
5869
### `promise readDir(path, directory)`
5970

6071
Reads the contents of `path` in `directory`.

0 commit comments

Comments
 (0)