Skip to content

Commit 6e8b3e3

Browse files
authored
Merge pull request #358 from rozele/readme
docs(README): update docs with basic info for Windows
2 parents 36ce87a + b08ce55 commit 6e8b3e3

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Native filesystem access for react-native
1111
- Fixed Podfile Path-Error (https://github.com/itinance/react-native-fs/commit/9fd51e7e977400f3194c100af88b4c25e7510530) thx to [colorfulberry](https://github.com/colorfulberry)
1212
- Add read-method with length and position params (https://github.com/itinance/react-native-fs/commit/a39c22be81f0c1f2263dbe60f3cd6cfcc902d2ac) thx to [simitti](https://github.com/simitii)
1313

14-
15-
1614
## Changes for v2.3
1715

1816
- React-Native 0.40 is minimum required for compiling on iOS (otherwise install an older release, see below)
@@ -171,6 +169,18 @@ public class MainApplication extends Application implements ReactApplication {
171169
}
172170
```
173171

172+
## Usage (Windows)
173+
174+
### Adding automatically with react-native link
175+
176+
The `link` command also works for adding the native dependency on Windows:
177+
178+
`react-native link react-native-fs`
179+
180+
### Adding Manually in Visual Studio
181+
182+
Follow the instructions in the ['Linking Libraries'](https://github.com/Microsoft/react-native-windows/blob/master/docs/LinkingLibrariesWindows.md) documentation on the react-native-windows GitHub repo. For the first step of adding the project to the Visual Studio solution file, the path to the project should be `../node_modules/react-native-fs/windows/RNFS/RNFS.csproj`.
183+
174184
## Examples
175185

176186
### Basic
@@ -309,7 +319,7 @@ The following constants are available on the `RNFS` export:
309319
- `MainBundlePath` (`String`) The absolute path to the main bundle directory
310320
- `CachesDirectoryPath` (`String`) The absolute path to the caches directory
311321
- `DocumentDirectoryPath` (`String`) The absolute path to the document directory
312-
- `TemporaryDirectoryPath` (`String`) The absolute path to the temporary directory (iOS only)
322+
- `TemporaryDirectoryPath` (`String`) The absolute path to the temporary directory (iOS and Windows only)
313323
- `LibraryDirectoryPath` (`String`) The absolute path to the NSLibraryDirectory (iOS only)
314324
- `ExternalDirectoryPath` (`String`) The absolute path to the external files, shared directory (android only)
315325
- `ExternalStorageDirectoryPath` (`String`) The absolute path to the external storage, shared directory (android only)

0 commit comments

Comments
 (0)