From ef76d5021874225cc0ed3133e12db0d5ae2c038a Mon Sep 17 00:00:00 2001 From: Mohammad Amin Date: Wed, 30 Aug 2023 18:24:01 +0330 Subject: [PATCH 1/3] Updated README.md! --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 574e228..a154cf4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ +[![Maintainability](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/maintainability)](https://codeclimate.com/github/TogetherCrew/core-analyzer-lib/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/test_coverage)](https://codeclimate.com/github/TogetherCrew/core-analyzer-lib/test_coverage) + # tc-core-analyzer -This repository is made for togethercrew core-analyzer scripts that could be used across different platforms. +This repository is made for togethercrew core-analyzer scripts that could be used across different platforms. To install this library + +```bash +pip install tc-core-analyzer-lib +``` From 075d5ce5a7d91120bc523dc3e3e3f5f313853330 Mon Sep 17 00:00:00 2001 From: Mohammad Amin Date: Wed, 30 Aug 2023 18:29:43 +0330 Subject: [PATCH 2/3] Added usage example! --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index a154cf4..5fc570b 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,9 @@ This repository is made for togethercrew core-analyzer scripts that could be use ```bash pip install tc-core-analyzer-lib ``` + +Usage: + +```Python +from tc_core_analyzer_lib.assess_engagement import EngagementAssessment +``` From 3d30e56ffaabba2bd5ec2f4794d656ab10deae0c Mon Sep 17 00:00:00 2001 From: Mohammad Amin Date: Wed, 30 Aug 2023 18:55:00 +0330 Subject: [PATCH 3/3] Fixed README linter issue! --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5fc570b..a2e5403 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ +# tc-core-analyzer + [![Maintainability](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/maintainability)](https://codeclimate.com/github/TogetherCrew/core-analyzer-lib/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/test_coverage)](https://codeclimate.com/github/TogetherCrew/core-analyzer-lib/test_coverage) -# tc-core-analyzer - This repository is made for togethercrew core-analyzer scripts that could be used across different platforms. To install this library ```bash