documentation

README.md

@@ -1,5 +1,9 @@
 # Flight Schedule Pro Scripts
 
+## Disclaimer
+
+Expect this shit to break at any point. Most likely when you really need it.
+
 ## Requirement
 Python 3
 Pip
@@ -8,14 +12,16 @@ Firefox
 ## Install
 
 Clone this repository
+
+Navigate to the resulting directory
+
+Create a virtual environment and install dependencies
 ```bash
-#navigate to the folder
-cd fsp_scripts
-#create a virtual environment and install dependencies
-python -m vene .venv
+python -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
 ```
+
 Update config.ini with you Flight Schedule Pro username and password
 
 ## Config
@@ -32,15 +38,18 @@ Downloads individual session PDFs for students and merges them into a single PDF
 #### Usage
 
 ```bash
-#At a minimum the script requires one argument, the name of a student to retrieve sessions for
+# At a minimum the script requires one argument, the name of a student to retrieve sessions for
 python save_progress_reports.py "Greg Johnson"
 
-#Also accepts multiple students
+# Also accepts multiple students
 python save_progress_reports.py "Greg Johnson" "Casey Serbagi"
 
-#Partial names work as well (retrieves the first matching student name found)
+# Partial names work as well (retrieves the first student with a matching name)
 python save_progress_reports.py Greg
 
-#More usage details
+# List students 
+python save_progress_reports.py -l
+
+# More usage details
 python save_progress_reports.py --help
 ```