Merge branch 'main' of https://github.com/ctrf-io/teams-ctrf

README.md

@@ -4,15 +4,16 @@
 
 ![Example view](assets/results.png)
 
-⭐ **If you find this project useful, consider giving it a GitHub star** ⭐
+## **⭐⭐ If you find this project useful, consider giving it a GitHub star ⭐⭐**
 
-It means a lot to us and helps us grow this open source library.
+## You can help us grow
 
-## Help us grow CTRF
+Support our mission to enhance test reporting in Microsoft Teams by:
 
-⭐ **If you find this project useful, please consider following the [CTRF organisation](https://github.com/ctrf-io) and giving this repository a star** ⭐
+- **⭐ Starring this repository to show your support. ⭐**
+- **🙌 Following our [GitHub page here](https://github.com/ctrf-io) to stay updated. 🙌**
 
-**It means a lot to us and helps us grow this open source library.**
+Thank you! Your support is invaluable to us! 💙
 
 ## Features
 
@@ -23,7 +24,7 @@ It means a lot to us and helps us grow this open source library.
 
 ## Setup
 
-You'll need a CTRF report generated by your testing framework. [CTRF reporters](https://www.ctrf.io/docs/category/reporters) are available for most testing frameworks and easy to install.
+You'll need a CTRF report generated by your testing framework. [CTRF reporters](https://github.com/orgs/ctrf-io/repositories) are available for most testing frameworks and easy to install.
 
 **No CTRF reporter? No problem!**
 
@@ -87,6 +88,20 @@ npx teams-ctrf results /path/to/ctrf-file.json -f
 
 - `--onFailOnly, -f`: Send notification only if there are failed tests.
 
+## Merge reports
+
+You can merge reports if your chosen reporter generates multiple reports through design, parallelisation or otherwise.
+
+The [ctrf-cli](https://github.com/ctrf-io/ctrf-cli) package provides a method to merge multiple ctrf json files into a single file.
+
+After executing your tests, use the following command:
+
+```sh
+npx ctrf merge <directory>
+```
+
+Replace directory with the path to the directory containing the CTRF reports you want to merge.
+
 ## What is CTRF?
 
 CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.