You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update readme to advise on react-native-windows versioning (#189)
As `react-native-windows` is not keeping pace with `react-native` we will have to advise users in the README.
Also, update some of the steps to create your own application with `react-native-pspdfkit`.
Copy file name to clipboardExpand all lines: README.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -621,6 +621,8 @@ Shows the pdf `document` from the local device filesystem, or your app's assets.
621
621
- PSPDFKit for Windows.vsix (installed)
622
622
- PowerShell
623
623
624
+
*IMPORTANT*:`react-native-pspdfkit`for windows does not yet support react-native 0.59.\*. Currently [`react-native-windows`][https://github.com/Microsoft/react-native-windows/releases] is not keeping up pace with `react-native`, where the last official release was 0.54.\* and the last RC was 0.57.\*. We have tested and require 0.57.0 to keep version aligned as much as possible.
625
+
624
626
#### Getting Started
625
627
626
628
Let's create a simple app that integrates PSPDFKit and uses the react-native-pspdfkit module.
@@ -629,22 +631,23 @@ Let's create a simple app that integrates PSPDFKit and uses the react-native-psp
629
631
2. Make sure `react-native-cli` is installed: `yarn global add react-native-cli`.
630
632
3. Install Windows Tool for React Native: `yarn add global windows-build-tools`.
631
633
4. Open `x64 Native Tools Command Prompt for VS 2017` program.
632
-
5. Create the app with `react-native init --version=0.55.4 YourApp` in a location of your choice.
634
+
5. Create the app with `react-native init --version=0.57.8 YourApp` in a location of your choice.
633
635
6. Step into your newly created app folder: `cd YourApp`.
634
636
7. Install the Windows helper plugin: `yarn add --dev rnpm-plugin-windows`.
635
-
8. Install `react-native-pspdfkit` from GitHub: `yarn add github:PSPDFKit/react-native`.
637
+
8. Install `react-native-pspdfkit` from GitHub: `yarn add github:PSPDFKit/react-native#windows-1.11.0`.
636
638
9. Install `react-native-fs` from GitHub: `yarn add react-native-fs`.
637
639
10. Install all modules for Windows: `yarn install`. (Because of a [bug](https://github.com/yarnpkg/yarn/issues/2165) you may need to clean `yarn`'s cache with `yarn cache clean` before.)
638
640
11. Initialize the windows project: `react-native windows`.
639
641
12. Link module `react-native-pspdfkit`: `react-native link react-native-pspdfkit`.
640
-
13. Open the Visual Studio solution in`react-native\YourApp\windows`.
641
-
14. Accept and install any required extensions when prompted.
642
-
15. If the settings window opens, click on `Developer` and select`yes`.
643
-
16. Mark `PSPDFKit SDK` and `Visual C++ Runtime` as dependencies for`YourApp`:
642
+
13. Link module `react-native-fs`: `react-native link react-native-fs`.
643
+
14. Open the Visual Studio solution in`react-native\YourApp\windows`.
644
+
15. Accept and install any required extensions when prompted.
645
+
16. If the settings window opens, click on `Developer` and select`yes`.
646
+
17. Mark `PSPDFKit SDK` and `Visual C++ Runtime` as dependencies for`YourApp`:
644
647
Right click on `YourApp` -> Add -> Refererece... Click on Projects and tick `ReactNativePSPDFKit`. Click on Universal Windows -> Extensions and tick `PSPDFKit for UWP` and `Visual C++ 2015 Runtime for Universal Windows Platform Apps`then click ok.
0 commit comments