summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan Roig <jaroig@outlook.com>2023-11-14 04:23:18 -0500
committerJuan Roig <jaroig@outlook.com>2023-11-14 04:23:18 -0500
commitaa16b741d54325527eb6bea451cb24526551ab52 (patch)
tree812112d664df26e85484aee72ca06e8f15bebadf /README.md
parentdc7d8df66bb78485cd935118c4840fde4cb6fe4e (diff)
Add list courses functions, remove unnecessary functions, update README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 5735615..db117a3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,23 @@
1# aplus 1# aplus
2 2
3aplus cli 3This is an aplus cli utility created for students at Florida Polytechnic University to submit their aplus codes through the CLI.
4In time, we intend to generalize this utility to all universities.
5In 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.
4 6
5# Usage 7## Usage
6 8
7# Launch interactive prompt 9### List all courses and canvas course codes
8aplus 10aplus
11aplus --list-courses
12aplus -l
9 13
10# Enter code immediately 14### List favorite courses and canvas course codes
15aplus --list-favorites
16
17### Enter code immediately for an active code
11aplus -c <code> 18aplus -c <code>
12aplus --code <code> 19aplus --code <code>
13 20
21### Enter code for a specified course
22aplus -c <code> --course <course_code>
23aplus --code <code> --course <course_code> \ No newline at end of file