Update README.md

README.md

@@ -1 +1,42 @@
 # rn-boilerplate
+
+## About
+This is a react native boilerplate with many useful component such as:
+
+- Login stack with login screen
+- Home stack with tow screens
+- Scan stack
+- Settings stack with tow screens
+- Custom animated Tab navigation bar `react-navigation v5`
+- Custom <InputText/>
+- Custom <Text/>
+- Custom icons library using RemixIcons v2.5
+
+## How it works
+- First run `yarn install && cd ios && pod install && cd ..`
+- Or `npm install && cd ios && pod install && cd ..`
+### Build flavors
+rn-boilerplate came with 2 build flavors for both platform
+#### ANDROID ![android-character-symbol](https://user-images.githubusercontent.com/58466201/122646313-748fd100-d116-11eb-9aef-e9fa8d7f67d2.png)
+
+##### Staging
+- Debug `yarn android-staging`
+- release `yarn android-staging-release`
+##### Production
+- Debug `yarn android-production`
+- release `yarn android-production-release`
+#### iOS ![app-store (2)](https://user-images.githubusercontent.com/58466201/122647245-29c48800-d11b-11eb-82a9-4117103d5895.png) 
+##### Staging
+- Debug `yarn ios-staging`
+- release `yarn ios-staging-release`
+##### Production
+- Debug `yarn ios-production`
+- release `yarn ios-production-release`
+
+## Preview
+![prevview (1)](https://user-images.githubusercontent.com/58466201/122646126-950b5b80-d115-11eb-80d0-41aea5ea2048.gif)
+##
+Please open an issue if something doesn't work or is not clear enough.
+
+
+