Merge pull request #301 from yashksaini-coder/yash/fix-118

Fix: Documentation Improvement

.github/workflows/add-contributor.yml

@@ -0,0 +1,26 @@
+name: Update Contributors in README
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+jobs:
+  contrib-readme-job:
+    runs-on: ubuntu-latest
+    name: A job to automate contrib in readme
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Update Contributors List
+        uses: akhilmhdh/[email protected]
+        with:
+          commit_message: "Updated contributors list"
+          committer_username: "yashksaini-coder"
+          committer_email: "[email protected]"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,15 +1,131 @@
-SkillWise
+<div align="center">
 
-![SkillWise Desktop Image](./readme-images/desktop.png)
+# `SkillWise`
 
-SkillWise is an innovative online platform designed to help learners of all ages acquire new skills and knowledge. With a wide range of engaging courses and expert instructors, SkillWise provides the tools you need to succeed in today’s competitive world.
+<br>
+<img src='./readme-images/desktop.png'>
+<br>
 
-Features
-Interactive and engaging courses across various fields.
-Expert instructors offering valuable insights.
-A supportive community for learners.
-Personalized learning paths to help you reach your goals.
+*<i>SkillWise is an innovative online platform designed to help learners of all ages acquire new skills and knowledge. With a wide range of engaging courses and expert instructors, SkillWise provides the tools you need to succeed in today’s competitive world.</i>*
 
-## please read the contributing rules before making a contribution
+<br>
 
-Read the [contributing](https://github.com/PriyaGhosal/SkillWise/contribute.md) rules who are new to Open-Source contribution
+<table align="center">
+    <thead align="center">
+        <tr border: 1px;>
+            <td><b>🌟 Stars</b></td>
+            <td><b>🍴 Forks</b></td>
+            <td><b>🐛 Issues</b></td>
+            <td><b>🔔 Open PRs</b></td>
+            <td><b>🔕 Close PRs</b></td>
+        </tr>
+     </thead>
+    <tbody>
+         <tr>
+            <td><img alt="Stars" src="https://img.shields.io/github/stars/PriyaGhosal/SkillWise?style=flat&logo=github"/></td>
+            <td><img alt="Forks" src="https://img.shields.io/github/forks/PriyaGhosal/SkillWise?style=flat&logo=github"/></td>
+            <td><img alt="Issues" src="https://img.shields.io/github/issues/PriyaGhosal/SkillWise?style=flat&logo=github"/></td>
+            <td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/PriyaGhosal/SkillWise?style=flat&logo=github"/></td>
+            <td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/PriyaGhosal/SkillWise?style=flat&color=critical&logo=github"/></td>
+        </tr>
+    </tbody>
+</table>
+</div>
+<br>
+
+
+
+Welcome to **SkillWise**, an innovative online platform designed to help learners of all ages acquire new skills and knowledge. With a wide range of engaging courses and expert instructors, SkillWise provides the tools you need to succeed in today’s competitive world.
+
+## Features
+
+- **Interactive Courses**: Engaging and interactive courses across various fields.
+- **Expert Instructors**: Learn from industry experts who offer valuable insights.
+- **Supportive Community**: Join a community of learners who support each other.
+- **Personalized Learning Paths**: Tailored learning paths to help you reach your goals.
+
+## Prerequisites
+
+Ensure you have the following installed:
+
+- **Git**: Version control system to manage and track changes in your codebase. [Download Git](https://git-scm.com/downloads)
+- **Node.js**: JavaScript runtime environment to run the project. [Download Node.js](https://nodejs.org/)
+- **npm**: Node package manager to install dependencies. It comes bundled with Node.js.
+- **Web Browser**: A modern web browser like Google Chrome or Firefox for testing the application.
+
+## Getting Started
+
+## Getting Started
+
+Follow these steps to start your learning journey with SkillWise:
+
+1. **Sign Up**: Create your SkillWise account by visiting our [sign-up page](#).
+2. **Browse Courses**: Discover a variety of courses across different fields. Use the search and filter options to find courses that match your interests.
+3. **Enroll**: Join the courses that interest you by clicking the "Enroll" button on the course page.
+4. **Learn and Grow**: Start learning at your own pace. Track your progress through the course dashboard and complete assignments to reinforce your knowledge.
+
+Enjoy your learning experience with SkillWise!
+
+## Contributing
+
+We welcome contributions from the community. To contribute, follow these detailed steps:
+
+1. **Fork the Repository**:
+    - Navigate to the repository on GitHub.
+    - Click the [Fork](https://github.com/PriyaGhosal/SkillWise/fork) button at the top right of the page to create a copy of the repository under your GitHub account.
+    - For more information, see [GitHub's Forking Guide](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo).
+
+2. **Clone the Forked Repository**:
+    - Open your terminal or command prompt.
+    - Clone your forked repository to your local machine using the command:
+      ```bash
+      git clone https://github.com/your-username/SkillWise.git
+      ```
+    - Replace `your-username` with your GitHub username.
+
+3. **Create a New Branch**:
+    - Navigate to the repository directory:
+      ```bash
+      cd SkillWise
+      ```
+    - Create a new branch for your feature or bug fix:
+      ```bash
+      git checkout -b feature-branch
+      ```
+    - Replace `feature-branch` with a descriptive name for your branch.
+
+4. **Make Your Changes**:
+    - Implement your changes or additions in the codebase.
+    - Ensure your changes follow the project's coding standards and guidelines.
+
+5. **Commit Your Changes**:
+    - Stage your changes:
+      ```bash
+      git add .
+      ```
+    - Commit your changes with a meaningful commit message:
+      ```bash
+      git commit -m 'Add some feature'
+      ```
+    - Replace `'Add some feature'` with a descriptive message about your changes.
+
+6. **Push to the Branch**:
+    - Push your changes to your forked repository on GitHub:
+      ```bash
+      git push origin feature-branch
+      ```
+
+7. **Open a Pull Request**:
+    - Navigate to the original repository on GitHub.
+    - Click the "Compare & pull request" button next to your recently pushed branch.
+    - Provide a clear and detailed description of your changes in the pull request.
+    - Submit the pull request for review.
+
+For more detailed instructions, refer to [GitHub's Guide on Creating a Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+
+Thank you for your contributions to SkillWise!
+
+# Contributors
+
+<!-- readme: contributors -start -->
+<!-- readme: contributors -end -->