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