Add extract.py script to Makefile

[phrases.git] / README.md

diff --git a/README.md b/README.md
index c8e3270b18bd3e9dc97779e16b3d96c728919664..8ceb3590272745391fe93435caf90a7c47b12fb2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,23 @@
 # phrases
-Get Latin famous phrases in the terminal
-
-## Source of phrases
-There are currently 2239 phrases in the database, sourced from the Wikipedia page [List of Latin phrases (full)](https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908)
-
-Wikipedia contributors, "List of Latin phrases (full)," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908. 
+Latin famous phrases in the terminal
 
 ## Installation
-`sudo make` to install.
+### On Linux + MacOS
+`sudo make install` to install the `phrases` script.  
+`sudo make install-extract` to install the `phrases-extract` script.  
+`sudo make uninstall` to uninstall completely.  
+`sudo make reinstall` to reinstall.  
 
-`sudo make uninstall` to uninstall completely.
+The program can also be run without installing as well
 
 ### Notes
-  * If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module.
+  * The `extract.py` script (installed in $PATH as `phrases-extract`) requires the beautifulsoup4 Python module
   * Tested and written on Python 3.9.0
 
+## Source of famous phrases
+Wikipedia contributors, "List of Latin phrases (full)," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908. 
+
+There are currently 2201 famous phrases in the database
+
 ## License
 Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.