Merge pull request #3 from TogetherCrew/Update-README

updated README.md!
TogetherCrew · Sep 5, 2023 · 92399a5 · 92399a5
2 parents 4a711ab + aa67bc5
commit 92399a5
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# python-library
+# neo4j-lib-py
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/maintainability)](https://codeclimate.com/github/TogetherCrew/neo4j-lib-py/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/e1239b895f0ee2569b61/test_coverage)](https://codeclimate.com/github/TogetherCrew/neo4j-lib-py/test_coverage)
+
+This repository contains a shared python library for accessing neo4j database. We're using it across different TogetherCrew python projects.
+
+To install the library:
+
+```bash
+pip install tc-neo4j-lib-py
+```
+
+Usage:
+
+```Python
+from tc_neo4j_lib.neo4j_ops import Neo4jOps
+```