Improvement: Updated README

[saadberry]

Changes

• Improved content in README
• Updated Main description
• Bumped version to 4.10.2

[github-actions]

Coverage report

❌ An unexpected error occurred. For more details, check console

Error: The process '/usr/local/bin/yarn' failed with exit code 1

St.❔	Category	Percentage	Covered / Total
🟢	Statements	81.72%	2642/3233
🟡	Branches	70.26%	905/1288
🟢	Functions	80.88%	368/455
🟢	Lines	83.99%	2492/2967

Test suite run failed

Failed tests: 2/310. Failed suites: 2/28.

  ● handleRenameFile › For File in sub directory

    expect(received).toBe(expected) // Object.is equality

    Expected: false
    Received: true

      242 |     const renamedShadowFilePath = path.join(shadowRepoBranchPath, newRelPath);
      243 |     // Verify file has been renamed in the shadow repo
    > 244 |     expect(fs.existsSync(oldShadowFilePath)).toBe(false);
          |                                              ^
      245 |     expect(fs.existsSync(renamedShadowFilePath)).toBe(true);
      246 |     // Verify correct diff file has been generated
      247 |     let diffFiles = fs.readdirSync(diffsRepo);

      at toBe (tests/helpers/helpers.js:244:46)
      at Object.<anonymous> (tests/test_events/handler/handleRename.test.js:234:33)

---

  ● bufferHandler › SocketEvents: onMessage, New File Diff along with changes diff

    expect(received).toBe(expected) // Object.is equality

    Expected: false
    Received: true

      528 |         handled = await webSocketEvents.onMessage(msg);
      529 |         expect(handled).toBe(true);
    > 530 |         expect(fs.existsSync(diffFilePathForChanges)).toBe(false);
          |                                                       ^
      531 |
      532 |     });
      533 |

      at Object.toBe (tests/test_codesyncd/buffer_handler.test.js:530:55)

Report generated by 🧪jest coverage report action from 813607a

[codesyncapp]

Check out the playback for this Pull Request here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud