Merge branch 'main' into update-package-versions

TogetherCrew · Dec 19, 2023 · 81fb18c · 81fb18c
2 parents fb37c72 + 20c5b7c
commit 81fb18c
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,18 @@
-# python-library
+# neo4j-lib-py
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/9d2ca104782798b9ed1d/maintainability)](https://codeclimate.com/github/TogetherCrew/neo4j-lib-py/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9d2ca104782798b9ed1d/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
+```
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 setup(
     name="tc-neo4j-lib",
-    version="1.0.0",
+    version="1.0.1",
     author="Mohammad Amin Dadgar, TogetherCrew",
     maintainer="Mohammad Amin Dadgar",
     maintainer_email="[email protected]",