#1, Readme file updated

README.md

@@ -1,39 +1,73 @@
 # Workout Tracker App
 
-## Overview
+This **Workout Tracker App** is a React Native application built with TypeScript (TSX). It helps users track their workouts and progress over time, whether they work out at home or on the go. The app offers a range of features like tracking today's home workouts, viewing the last 5 workout days, adding custom workouts, and viewing a calendar to jump to specific dates. The app also organizes preloaded workouts by muscle group for ease of use.
 
-The Workout Tracker App is a mobile application developed using React Native to help users log and track their daily workout routines. The app allows users to select from a list of exercises categorized by different muscle groups and record details of their workout sessions. This app is ideal for fitness enthusiasts looking to monitor their exercise routines.
+## Features
 
-## Usage
-- Select Muscle Group: Choose a muscle group (e.g., biceps, triceps, chest) to view related exercises.
-- Log Workout: For each exercise, record sets, reps, and weights used.
-- Track Progress: The app provides a workout history that shows the progress made over time.
-- Add Custom Exercises: Add new exercises if they’re not available in the predefined list.
+- **Today's Workouts at Home**: Track all the workouts done at home today and compare them to previous days.
+- **Recent Workout History**: View the workouts of the last 5 workout days at home for easy reference.
+- **Customizable Workouts**: Add your own custom workouts, modify them as needed, and delete if they are no longer relevant.
+- **Workout by Muscle Group**: Select workouts from a predefined list of exercises based on muscle groups (e.g., chest, arms, legs, etc.).
+- **Calendar View**: Navigate to any date to view or plan your workouts, giving you a clear timeline of your workout journey.
+
+## Screenshots
 
-## Tech Stack
-- React Native: For building the mobile application.
-- JavaScript/TypeScript: Core development language for logic and UI components.
-- AsyncStorage: For local data storage.
-- NativeWind (Optional): For UI styling.
+<!-- Add screenshots of your app here, if available. For example: -->
+- **Home Screen**: Shows today's workouts and history of the last 5 days.
+- **Workout List**: Displays workouts filtered by muscle groups.
+- **Calendar View**: Provides access to workouts on specific dates.
 
 ## Installation
 
-1. Clone the repository:
+To run this app locally, follow these steps:
+
+1. **Clone the Repository:**
+   ```bash
+   git clone https://github.com/praveenraam/RN-Workout_Tracker.git
+   cd workout-tracker-app
+   ```
+2. **Install Dependencies:** Use npm or yarn to install the required packages:
+
+    ``` bash
+    npm install
+    # or
+    yarn install
+    ```
+
+3. **Start the App:** You can run the app using the React Native CLI or Expo (if using Expo setup). For example, to start with React Native CLI:
+
+    ``` bash
+    npx react-native start
+    ```
+4. **Run on Emulator or Device:** In a separate terminal window, run:
+
+    ``` bash
+    npx react-native run-android  # for Android
+    npx react-native run-ios      # for iOS
+    ```
+## Usage
+1. **Home Screen:** Displays today's workouts at home and the last 5 days of home workout history.
+2. **Adding a Workout:** From the workout screen, you can:
+- Select a workout from the preloaded list by muscle group.
+- Add a custom workout by entering your exercise details.
+3. **Editing/Deleting a Workout:** Modify or remove a workout by tapping on it in the history or today's workout list.
+4. **Using the Calendar:** Access the calendar feature to jump to a specific date and view the workout completed on that day, or plan upcoming workouts.
 
-```Bash
-git clone https://github.com/praveenraam/RN-Workout_Tracker.git
-cd RN-Workout_Tracker
-```
+## Customization
+#### Adding More Workouts
+To add more predefined workouts by muscle group, you can modify the workoutData.ts (or relevant data file) and include new exercises under each muscle group.
 
-2. Install dependencies
+#### Adding Custom Workouts
+Users can also add their custom exercises via the "Add Custom Workout" feature from the app interface.
 
-```Bash
-npm install
-```
+## Contributing
+We welcome contributions to improve this app. Here's how you can help:
 
-## Contact
-If you have any queries or want to connect, feel free to reach out through the following platforms:
+1. Fork the repository.
+2. Create a new branch with your feature or bugfix (`git checkout -b feature/new-feature`).
+3. Commit your changes (`git commit -m 'Add new feature'`).
+4. Push the branch (`git push origin feature/new-feature`).
+5. Open a Pull Request and describe your changes.
 
-- [Email](mailto:[email protected])
-- [GitHub](https://github.com/praveenraam)
-- [LinkedIn](https://linkedin.com/in/praveenraam)
+## License
+This project is licensed under the MIT License. See the LICENSE file for details.