Merge pull request #12 from JulesBelveze/docs/clean-up

chore: fix documentation and pypi
JulesBelveze · Jul 31, 2022 · b4b54f3 · b4b54f3
2 parents 81d560e + 9122214
commit b4b54f3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 # concepCy
 
+[![PyPI version](https://badge.fury.io/py/concepCy.svg)](https://pypi.org/project/concepCy/)
+[![github actions docs](https://github.com/JulesBelveze/concepcy/actions/workflows/documentation.yaml/badge.svg)](https://julesbelveze.github.io/concepcy/)
+
 `concepCy` is a spaCy wrapper for [ConceptNet](https://conceptnet.io/), a freely-available semantic network designed to
 help computers understand the meaning of words.
 
@@ -120,6 +123,11 @@ nlp.add_pipe(
 )
 ```
 
+# Documentation 📚
+
+The whole documentation along with design decisions and examples can be
+found [here](https://julesbelveze.github.io/concepcy/).
+
 # References
 
 * [ConceptNet 5.5: An Open Multilingual Graph of General Knowledge](https://arxiv.org/abs/1612.03975)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "concepcy"
-version = "0.1.1"
-description = "SpaCy wrapper for ConceptNet"
+name = "concepCy"
+version = "0.1.0"
+description = "💫 SpaCy wrapper for ConceptNet 💫"
 authors = ["JulesBelveze <jules.belveze@hotmail.fr>"]
 homepage = "https://github.com/JulesBelveze/concepcy"
 repository = "https://github.com/JulesBelveze/concepcy"