Update phrase database

[phrases.git] / README.md

diff --git a/README.md b/README.md
index 9e3f64520ae9ea812b41142df76839db3127f325..b38c18097d989810f2d73ee8e73b0d63222c3d3f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,22 @@
 # phrases
-Get latin famous phrases in your terminal!
-
-## Source
-The Wikipedia page "[List of Latin phrases (full)](https://en.wikipedia.org/wiki/List_of_Latin_phrases_(full))". See the references [here](https://en.wikipedia.org/wiki/List_of_Latin_phrases_(full)#References) for more information
+Latin famous phrases in the terminal
 
 ## Installation
-`sudo make`
+### On Linux + MacOS
+`sudo make` to install.
+
+`sudo make uninstall` to uninstall completely.
+
+The program can also be run without installing as well
+
+### Notes
+  * The `extract.py` script 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
+Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.