Merge pull request #634 from prachimulay17/docs/fix-doctype

DOC: Fix Typos in README.md and ONBOARDING.md

Author: M4dhav

ONBOARDING.md

@@ -1,11 +1,11 @@
 # Onboarding Guide
 
-Client side set up is straight forward and standard, i.e clone the repo [Resonte Client Side Repo](https://github.com/AOSSIE-Org/Resonate), do `flutter pub get` in the root of the project etc so this guide would focus on the backend env set up.
+Client-side set-up is straightforward and standard, i.e., clone the repo [Resonate Client Side Repo](https://github.com/AOSSIE-Org/Resonate), do `flutter pub get` in the root of the project, etc. This guide would focus on the backend env setup.
 
-Please strictly stick to the guide do not go off installing stuff on your own
+Please strictly stick to the guide; do not go off installing stuff on your own.
 
 > #### **Setting up Firebase for FCM**
-> To ensure that new contributors do not have to setup firebase projects, all Firebase functionality (Only used for Notifications via FCM) has been disabled in the application. To enable this functionality (if you want to test notifications), setup a project on firebase, configure Resonate to use your project using this [guide](https://firebase.google.com/docs/flutter/setup) and uncomment the Firebase and FCM specific code in the files: ```main.dart , auth_state_controller.dart, and upcomming_rooms_controller.dart ``` Also, in the [Resonate Backend Repo](https://github.com/AOSSIE-Org/Resonate-Backend), uncomment the FCM and Firebase code in the `Upcoming Rooms Time Checker Function` and add your google-services.json in the folder for that function before setting up the localhost backend. 
+> To ensure that new contributors do not have to setup firebase projects, all Firebase functionality (Only used for Notifications via FCM) has been disabled in the application. To enable this functionality (if you want to test notifications), set up a project on firebase, configure Resonate to use your project using this [guide](https://firebase.google.com/docs/flutter/setup) and uncomment the Firebase and FCM-specific code in the files: ```main.dart, auth_state_controller.dart, and upcomming_rooms_controller.dart``` Also, in the [Resonate Backend Repo](https://github.com/AOSSIE-Org/Resonate-Backend), uncomment the FCM and Firebase code in the `Upcoming Rooms Time Checker Function` and add your google-services.json in the folder for that function before setting up the localhost backend. 
 <br/>
 
 ### Prerequisits (must be installed) for Backend Env Set-Up
@@ -23,7 +23,7 @@ Clone the [Resonate Backend Repo](https://github.com/AOSSIE-Org/Resonate-Backend
 <br/>
 
 
-Navigate to the root directory of the project in your terminal (for windows power shell), and run the command
+Navigate to the root directory of the project in your terminal (for Windows PowerShell), and run the command
 
 ##### Linux and MacOS
 
@@ -72,7 +72,7 @@ Thus my Team Id is `666ce18b003caf6274b6`, enter your team id in the terminal, o
 
 
 #### Auth Set Up
-The auth set up is intentially skipped as google Oauth did not allow private IP as allowed redirect URl's so we had to make the script open tunnels and once tunneling was introduced. It brought more complexities and conditions of working which degraded the scripts robustness 
+The auth set up is intentionally skipped as google Oauth did not allow private IP as allowed redirect URl's so we had to make the script open tunnels and once tunneling was introduced. It brought more complexities and conditions of working which degraded the scripts robustness 
 
 So we have decided to create a dedicated script for the rare case of testing the Oauth login buttons ('google', 'github') this script is work in progress and will be out soon. But for now email password signIn should work perfectly fine enabling you to explore full capabilities of the project with a robust script
 
@@ -83,7 +83,7 @@ Now you will be prompted for `Collection` Set Up
 
 ![Screenshot 2024-07-06 at 5 14 46 PM](https://github.com/Aarush-Acharya/Resonate/assets/92685647/5155b124-07e4-4769-a9f1-ac574816f85e)
 
-Press "a" to select all and press enter, same goes for  `Buckets` set up comming after this. The `Functions` will be pushed at then end of the script after the Livekit env vars are pushed as the Function need redeployment after a new env var is pushed in order to read the var.
+Press "a" to select all and press enter, same goes for  `Buckets` set up coming after this. The `Functions` will be pushed at the end of the script after the Livekit env vars are pushed as the Functions need redeployment after a new env var is pushed in order to read the var.
 
 This completes the Resonate project Set Up (functions will be pushed in the end) in your local Appwrite Instance 🚀🍀
 <br/>

README.md

@@ -45,7 +45,7 @@ With social voice platforms like Spotify, Clubhouse, and Twitter Spaces experien
 1. Real-time Audio Communication by joining rooms and talking to people.
 2. Ability to create rooms and moderate speakers and events.
 3. Create Scheduled Rooms and notify subscribers as reminders to join
-4. Listen to and Stories as chapters with synced lyrics, browse through entire catalog of stories following your favourate creators and waiting for their latest chapter/story releases. Post your own stories having chapters. (work in progess)
+4. Listen to and create Stories as chapters with synced lyrics, browse through entire catalog of stories following your favorite  creators and waiting for their latest chapter/story releases. Post your own stories having chapters. 
 5. Pair chatting to enable users to find random partners to talk to in the app.
 6. Friend People/Profiles enabling your self to talk on voice calls/realtime messaging with them (coming soon)
 
@@ -62,10 +62,10 @@ With social voice platforms like Spotify, Clubhouse, and Twitter Spaces experien
 
 ## :four_leaf_clover: Getting Started
 
-Resonate is a wide project taking use of other software solutions like Appwrite and Livekit, starting up can be a little challenging
+Resonate is a broad project that makes use of other software solutions like Appwrite and Livekit, starting up can be a little challenging.
 
 We offer a guide for walking you through setting up the entire project, including a script that automates the set up of the backend environment for you.
-Please go through and strictly follow the [Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md) for setting up the project for development and further contribution
+Please go through and strictly follow the [Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md) for setting up the project for development and further contributions.
 
 ## ▶️ Play Store Feature Graphic
 
@@ -96,7 +96,7 @@ Please go through and strictly follow the [Onboarding Guide](https://github.com/
 
 :star: Don't forget to star this repository if you find it useful! :star:
 
-Thank you for considering contributing to this project! Contributions are highly appreciated and welcomed (P.S. to the `dev` branch). To ensure a smooth collaboration, Refer to the [Contribution Guidelines](https://github.com/AOSSIE-Org/Resonate/blob/master/CONTRIBUTING.md).
+Thank you for considering contributing to this project! Contributions are highly appreciated and welcomed. (Please contribute to the `dev` branch.) To ensure smooth collaboration, refer to the Contribution Guidelines(https://github.com/AOSSIE-Org/Resonate/blob/master/CONTRIBUTING.md).
 
 We appreciate your contributions and look forward to working with you to make this project even better!