Add more details to readme

GabrielSCabrera · Dec 15, 2023 · 8cd3eec · 8cd3eec
1 parent 056d2e8
commit 8cd3eec
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -42,14 +42,14 @@ A class that provides an interface to convert spoken language into written text
 
 ### Important Note
 
-BanterBot requires several spaCy language models to run, and will automatically download them on first-time initialization, if they are missing -- this process can sometimes take a while.
+BanterBot requires several spaCy language models to run, and will automatically download them on first-time initialization, if they are missing or incompatible -- this process can sometimes take a while.
 
 ### Pip (Recommended)
 
-BanterBot is installable using the Python Package Index (PyPi):
+BanterBot can be installed or updated using the Python Package Index (PyPi):
 
 ```bash
-python -m pip install banterbot
+python -m pip install --upgrade banterbot
 ```
 
 ### Manual

diff --git a/docs/index.rst b/docs/index.rst
@@ -91,16 +91,17 @@ Important Note
 
 BanterBot requires several spaCy language models to run, and will
 automatically download them on first-time initialization, if they
-are missing -- this process can sometimes take a while.
+are missing or incompatible -- this process can sometimes take a while.
 
 Pip (Recommended)
 ~~~~~~~~~~~~~~~~~
 
-BanterBot is installable using the Python Package Index (PyPi):
+BanterBot can be installed or updated using the Python Package Index (PyPi):
 
 .. code:: bash
 
-   python -m pip install banterbot
+   python -m pip install --upgrade banterbot
+
 
 Manual
 ~~~~~~