Skip to content

Commit 2131334

Browse files
committed
chore: added notes about windows autolinking to docs
1 parent bd2bde5 commit 2131334

File tree

3 files changed

+15
-32
lines changed

3 files changed

+15
-32
lines changed

website/docs/Installation.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ yarn add @react-native-async-storage/async-storage
1414

1515
### Link
1616

17+
#### Android & iOS
18+
1719
- **React Native 0.60+**
1820

19-
[CLI autolink feature](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) links the module while building the app.
21+
[CLI autolink feature](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) links the module while building the app.
2022

21-
Use CocoaPods to add the native `RNAsyncStorage` to your project:
23+
On iOS, use CocoaPods to add the native `RNAsyncStorage` to your project:
2224

2325
```bash
2426
npx pod-install
@@ -31,4 +33,13 @@ npx pod-install
3133
react-native link @react-native-async-storage/async-storage
3234
```
3335

34-
*Note:* For `Windows` the [manual linking](Linking.md) is currently the only linking option.
36+
#### Windows
37+
38+
- **React Native Windows > 0.63**
39+
[CLI autolink feature](https://microsoft.github.io/react-native-windows/docs/native-modules-autolinking) links the module while building the app.
40+
41+
- **React Native Windows <= 0.62**
42+
For earlier versions check [manual linking](Linking.md)
43+
44+
#### macOS
45+
For `macOS` the [manual linking](Linking.md) is currently the only linking option.

website/docs/Linking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ protected List<ReactPackage> getPackages() {
8686
1. Open your solution in Visual Studio.
8787

8888
2. Right click Solution icon in Solution Explorer > Add > Existing Project.
89-
Select `node_modules\@react-native-async-storage\async-storage\windows\ReactNativeAsyncStorage\ReactNativeAsyncStorage.vcxproj`
89+
Select `node_modules\@react-native-async-storage\async-storage\windows\ReactNativeAsyncStorage\ReactNativeAsyncStorage.vcxproj` (on RNW 0.61, select `node_modules\@react-native-async-storage\async-storage\windows\ReactNativeAsyncStorage61\ReactNativeAsyncStorage61.vcxproj`)
9090

9191

9292
#### Add a reference to `ReactNativeAsyncStorage` in your main application project.

windows/README.md

-28
This file was deleted.

0 commit comments

Comments
 (0)