From aa16b741d54325527eb6bea451cb24526551ab52 Mon Sep 17 00:00:00 2001 From: Juan Roig Date: Tue, 14 Nov 2023 04:23:18 -0500 Subject: Add list courses functions, remove unnecessary functions, update README. --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5735615..db117a3 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ # aplus -aplus cli +This is an aplus cli utility created for students at Florida Polytechnic University to submit their aplus codes through the CLI. +In time, we intend to generalize this utility to all universities. +In the meantime however, any students from other universities wishing to use the utility may change the base_link and external_tools_code (you see this in the URL when you navigate to Aplus attendance within your course) variables. -# Usage +## Usage -# Launch interactive prompt +### List all courses and canvas course codes aplus +aplus --list-courses +aplus -l -# Enter code immediately +### List favorite courses and canvas course codes +aplus --list-favorites + +### Enter code immediately for an active code aplus -c aplus --code +### Enter code for a specified course +aplus -c --course +aplus --code --course \ No newline at end of file -- cgit v1.2.3