Create README.md

This commit is contained in:
Marc Rousavy 2021-02-23 12:04:27 +01:00
parent 3e2ee6c959
commit 8079592fbf

16
ios/README.md Normal file
View File

@ -0,0 +1,16 @@
# ios
This folder contains the iOS-platform-specific code for react-native-vision-camera.
## Prerequesites
1. Install need [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) and [SwiftLint](https://github.com/realm/SwiftLint)
```sh
brew install swiftformat swiftlint
```
## Getting Started
It is recommended that you work on the code using the Example project (`example/ios/VisionCameraExample.xcworkspace`), since that always includes the React Native header files, plus you can easily test changes that way.
You can however still edit the library project here by opening `VisionCamera.xcodeproj`.