feat: Add a readme for the example app (#12)

margelo · May 24, 2022 · 000cd1d · 000cd1d
1 parent 69ed3b4
commit 000cd1d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,10 @@
+# Example App Setup
+
+Want to try our react-native-graph right away? Check out the example app.
+
+## Steps to get the example app working on iOS
+
+1. `git clone` this repo
+2. `yarn install` in both the `/example` folder and in the top level.
+3. In the `example` folder, `npx pod-install` or `cd ios && pod install` to install iOS dependencies
+4. In the `example` folder, run `yarn ios`