updated readme

README.md

@@ -1,93 +1,107 @@
 ## Real Dev Squad Mobile App
 
-This is the repository of our mobile app, which will have all the features of our web apps.
-
+Welcome to the repository of our mobile app, which mirrors all the features of our web applications.
 ## Tech Stack
 
-React Native, TypeScript, StyleSheet
-
+   * React Native
+   * TypeScript
+   * StyleSheet
 ## About the Project
 
-This Project serves the RealdevSquad cross-platform-app. This project is built in React-Native.
-
+This project serves as the Real Dev Squad cross-platform mobile app, built using React Native.
 ## First Phase
 
-- Github Authentication ✅
-- Three Screens - Home , Task and Profile ✅
+- Github Authentication ✅ (we did it via webview, requirement has changed to browser login from github)
+- QR code Scanner Authentication ✅
+- Three Screens - Home and Profile ✅
 - Home screen Features ✅
 - Feature with switching from I am idle to doing task ✅
 - Feature with switching from out of office from back again ✅
 - Profile Screen in which we can change our profile through our phone’s gallery ✅
 - API integration in Profile Screen ✅
 
 ## Second Phase
-
-- QR code Scanner Authentication ✅
 - Three Screens - Home , Goals and Profile ✅
 - Home screen Features ✅
 - Goals site Tab
 - Goals site feature will have the TODO app where you can assign the task to the member of the RDS.
 
 Feel free to download our RDS app by clicking on ➡️ [RDS App](https://drive.google.com/file/d/1Y7IVr7HvYU_IYekh0Glt7aYrFiS7z19X/view?usp=sharing)
 
-Note : Please delete the previous RDS app build if you have.
+**Note** : Please delete the previous RDS app build if you have.
 
 
 ## Prerequisites
 
+
+To contribute, make sure you have the following:
+
 - React Native setup
 - Android Studio
 - JDK ( openjdk 11.0.20.1 2023-08-24 )
 - Node setup ( use version v16.*, tested on v16.20.2)
 - [Volta](https://docs.volta.sh/guide/getting-started) | [Why Volta?](https://docs.volta.sh/guide/#why-volta)
+- React Native development environment set up
+- Android Studio installed
+- Node.js installed
+- for Node version management: [Volta](https://docs.volta.sh/guide/getting-started) | [Why Volta?](https://docs.volta.sh/guide/#why-volta)
 
-## **NOTE** : Make sure to set up the proper development environment required to run react-native applications.
+# **NOTE** : Make sure to set up the proper development environment required to run Hello world app in RN and drop a video link in #react-native channel.
 
-You can refer : https://reactnative.dev/docs/environment-setup
+For detailed setup instructions,  refer to [React Native environment setup guide](https://reactnative.dev/docs/environment-setup).
 
 ### Local App setup
 
-- First set up with React native environment on your local machine. You can refer the [Environment Setup Link](https://reactnative.dev/docs/environment-setup)
-- If you have done the first point then congrats 🎉now you are good to go !
-- Now clone the mobile app Repo with [Github Repo Link](https://github.com/Real-Dev-Squad/mobile-app)
-- Run the command - `Yarn`.
-- Start contributing.
+- Set up your local environment for React Native following the environment setup guide.
+- Clone the mobile app repository: git clone https://github.com/Real-Dev-Squad/mobile-app.git
+- Run the command: `yarn`
+- Start contributing!
 
 ## Contribution Guide
 
-- You must have all the pre-requisites which are mentioned above.
-- Go through the issues and comment on the one which you like.
-- When an issue is assigned to you then just follow all the local App setup steps and you are good to do😊
-- Before pushing the code make sure you follow the below 👇steps
+To contribute to our project:
 
-  - Make sure you run the app on your local machine. It should not give any errors.
-  - Run `yarn run precommit-check`
-  - then Run `your git commands` to push your code.
-  - Make sure to give a proper commit message.
-
-- If you need any other help, feel free to ping on `mobile-app-react-native` channel at discord.
+- Browse the issues and comment on the one you'd like to work on.
+- Once an issue is assigned to you, follow the local app setup steps.
+- Before pushing code, ensure it runs without errors.
+- Run yarn run `precommit-check`.
+- Commit your changes with a descriptive message.
+- Push your code to your branch.
+- If you need assistance, reach out on the mobile-app-react-native channel on Discord.
 
 
-Git commands for local setup:
+## Git commands for local setup
 
-- `git clone https://github.com/Real-Dev-Squad/mobile-app.git`
-- `cd mobile-app`
-- `yarn`
+```
+git clone https://github.com/Real-Dev-Squad/mobile-app.git
 
-Git commands to commit your code:
+cd mobile-app
 
-- `git checkout -b 'your PR name'` 
-- `git add .`
-- `git commit -m "message"`
-- `git push origin your PR name`
+yarn
+```
 
-**TDD**
 
-- All the PRs should be raised with the 100% test coverage.
-- Before submitting the PRs you should run the command `yarn test` to check if all the tests are passed or not.
+## Git commands to commit your code:
+```
+git checkout -b 'your-PR-name'
+
+git add <files>
+
+git commit -m "Your commit message"
+
+git push origin your-PR-name
+
+```
+
+
+## Test-Driven Development (TDD)
+
+All PRs should have 100% test coverage. Before submitting PRs, run yarn test to ensure all tests pass.
 
 **Running/Development**
 
-- `yarn react-native start` - to start Metro, the JavaScript bundler that ships with React Native.
-- Let Metro Bundler run in its own terminal. Open a new terminal inside your React Native project folder. Run the following:
-- `yarn react-native run-android` - To start the emulator.
+- Start Metro (JavaScript bundler): yarn `react-native start`
+- For Android: `yarn react-native run-android`
+- For iOS: yarn `react-native run-ios`
+
+If the above commands fail, try building the Android app from Android Studio and the iOS app from Xcode.