Update example readmes

roiberlin · Oct 11, 2018 · 46fdc78 · 46fdc78
1 parent 4218b70
commit 46fdc78
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 44 deletions.
diff --git a/Example/AndroidExample/README.md b/Example/AndroidExample/README.md
@@ -3,9 +3,9 @@
 Demo application for Android
 
 ## Versions
-**React Native** 0.57.2
-**App Auth:** 0.94.0
-**React Native App Auth:** 3.1.0
+- **React Native** 0.57.2
+- **App Auth:** 0.94.0
+- **React Native App Auth:** 3.1.0
 
 ## Setup
 

diff --git a/Example/Latest/README.md b/Example/Latest/README.md
@@ -3,9 +3,9 @@
 Demo application that uses the version of react-native-app-auth in this repo
 
 ## Versions
-**React Native** 0.57.2
-**App Auth:** Latest
-**React Native App Auth:** Latest
+- **React Native** 0.57.2
+- **App Auth:** Latest
+- **React Native App Auth:** Latest
 
 ## Setup
 
@@ -25,10 +25,12 @@ yarn
 
 ## Run
 
+iOS
 ```
 react-native run-ios
 ```
 
+Android
 ```
 react-native run-android
 ```
diff --git a/Example/README.md b/Example/README.md
@@ -1,39 +1,10 @@
 # React Native App Auth Examples
 
-Example application for the `react-native-app-auth` library.
+Example applications for the `react-native-app-auth` library.
 
-![Demo](demo.gif)
-
-## Setup
-
-You'll need to have Yarn and the React Native CLI installed:
-
-```sh
-npm install --global yarn react-native-cli
-```
-
-Clone the repo and install dependencies
-
-```sh
-git clone https://github.com/FormidableLabs/react-native-app-auth.git
-cd ./react-native-app-auth/Example/Latest
-yarn
-```
-
-## Run
-
-iOS:
-
-```
-react-native run-ios
-```
-
-Android:
-
-```
-react-native run-android
-```
+This repo contains 4 React Native demo applications with the same JS code, but different native implementations.
 
+All the JS code can be found in `App.js`.
 
 ### Latest (Android & iOS)
 Latest code in the repo for both iOS and Android
@@ -46,3 +17,7 @@ iOS app only with the AppAuth dependency installed from Carthage
 
 ### Android
 Android app only
+
+## Demo
+
+![Demo](demo.gif)
diff --git a/Example/iOSCarthageExample/README.md b/Example/iOSCarthageExample/README.md
@@ -3,9 +3,9 @@
 Demo application installing the AppAuth dependency using Carthage
 
 ## Versions
-**React Native** 0.57.2
-**App Auth:** 0.94.0
-**React Native App Auth:** [from PR](https://github.com/FormidableLabs/react-native-app-auth/pull/189)
+- **React Native** 0.57.2
+- **App Auth:** 0.94.0
+- **React Native App Auth:** [from PR](https://github.com/FormidableLabs/react-native-app-auth/pull/189)
 
 ## Setup
 

diff --git a/Example/iOSPodsExample/README.md b/Example/iOSPodsExample/README.md
@@ -3,9 +3,9 @@
 Demo application installing the AppAuth dependency using Pods
 
 ## Versions
-**React Native** 0.57.2
-**App Auth:** 0.94.0
-**React Native App Auth:** 3.1.0
+- **React Native** 0.57.2
+- **App Auth:** 0.94.0
+- **React Native App Auth:** 3.1.0
 
 ## Setup