Fix style according to Flake8

[phrases.git] / README.md

diff --git a/README.md b/README.md
index 38dcb0835270466b5eb81a323b47869ca684dd3e..c8682af93679768c7338dfcc52c1604b83f41171 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,27 @@
 # phrases
-Get Latin famous phrases in the terminal
+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)
+## Installation
+Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs)
 
-    Wikipedia contributors. (2020, November 3). List of Latin phrases (full). In Wikipedia, The Free Encyclopedia. Retrieved 20:22, December 2, 2020, from https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908 
+`sudo make install` to install the `phrases` script.
 
-## Installation
-`sudo make` to install.
+`sudo make install-extract` to install the `phrases-extract` script.
+
+`sudo make uninstall` to uninstall completely
 
-`sudo make uninstall` to uninstall completely.
+`sudo make reinstall` to reinstall.
 
-### Notes
-  * If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module.
+The program can also be run without installing as well
+
+## Notes
+  * 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.