Merge pull request #10 from TogetherCrew/update-readme

Updated README.md!
TogetherCrew · Sep 5, 2023 · 3c5d685 · 3c5d685
2 parents f1f3676 + 3d30e56
commit 3c5d685
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,16 @@
 # tc-core-analyzer
 
-This repository is made for togethercrew core-analyzer scripts that could be used across different platforms.
+[![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)
+
+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
+```
+
+Usage:
+
+```Python
+from tc_core_analyzer_lib.assess_engagement import EngagementAssessment
+```