add argument parsing, fix program logic

[phrases.git] / README.md

diff --git a/README.md b/README.md
index 9e3f64520ae9ea812b41142df76839db3127f325..f13e0a169e2909f4458860872644f9c1c6ba82f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
 # phrases
-Get latin famous phrases in your terminal!
+Latin famous phrases in the 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
+## 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 2239 famous phrases in the database
 
 ## Installation
-`sudo make`
+`sudo make` to install.
+
+`sudo make uninstall` to uninstall completely.
+
+### Notes
+  * If you want to generate a new phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module.
+  * Tested and written on Python 3.9.0
 
 ## 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.