Update README.md

README.md

@@ -1,11 +1,45 @@
-## My Project
+## Building a Quiz Game with AWS Amplify Gen 2 and React Native
 
-TODO: Fill this README out!
+> This repository contains the app that is created through the blog post over [community.aws](https://community.aws/content/2oFXtL8vTeHWORWVkx8ak2gCgxf). For seeing a detailed explanation on how to build the app, check out the blog post.
 
-Be sure to:
+### Requirements
 
-* Change the title in this README
-* Edit your repository description on GitHub
+Before you move forward, be sure to have:
+- npm (Node Package Manager) installation
+- An AWS Account configured for local development
+  - Check out the [account configuration documentation](https://docs.amplify.aws/react/start/account-setup/) for detailed instructions.
+- Expo CLI
+
+### Running the project
+For running the project, first you need to install the npm libraries by running:
+
+```bash
+npm install
+```
+
+Next, you can run the new sandbox environment by running:
+```bash
+npx ampx sandbox
+```
+
+Next, if you are running on **Android**, be sure to add the Android SDK location to the `android/local.properties` file:
+```bash
+sdk.dir=/path/to/your/Android/sdk
+```
+
+Lastly, you can run the applications on both iOS and Android by running:
+
+```bash
+npx expo run:ios # for iOS
+npx expo run:android #for Android
+```
+
+### Cleaning up the resources
+Be sure to clean up your resources once you are done with the testing. You can clean the resources by running:
+
+```bash
+npx ampx sandbox delete
+```
 
 ## Security
 

ios/amplifyquiz.xcodeproj/project.pbxproj

@@ -351,7 +351,7 @@
 				);
 				OTHER_SWIFT_FLAGS = "$(inherited) -D EXPO_CONFIGURATION_DEBUG";
 				PRODUCT_BUNDLE_IDENTIFIER = com.example.amplifyQuiz;
-				PRODUCT_NAME = amplifyquiz;
+				PRODUCT_NAME = "amplifyquiz";
 				SWIFT_OBJC_BRIDGING_HEADER = "amplifyquiz/amplifyquiz-Bridging-Header.h";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				SWIFT_VERSION = 5.0;
@@ -379,7 +379,7 @@
 				);
 				OTHER_SWIFT_FLAGS = "$(inherited) -D EXPO_CONFIGURATION_RELEASE";
 				PRODUCT_BUNDLE_IDENTIFIER = com.example.amplifyQuiz;
-				PRODUCT_NAME = amplifyquiz;
+				PRODUCT_NAME = "amplifyquiz";
 				SWIFT_OBJC_BRIDGING_HEADER = "amplifyquiz/amplifyquiz-Bridging-Header.h";
 				SWIFT_VERSION = 5.0;
 				TARGETED_DEVICE_FAMILY = "1,2";