Merge pull request #186 from monperrus/patch-1

mention login step in doc
dbosk · Oct 31, 2024 · 3292472 · 3292472
2 parents d26ff36 + 5ed3d75
commit 3292472
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,14 @@ is `canvaslms` and it has several subcommands in the same style as Git.
 `canvaslms` provides output in a format useful for POSIX tools, this
 makes automating tasks much easier.
 
+## Getting started
+
+Start by login to your Canvas server
+
+``` {.text}
+canvaslms login
+```
+
 Let's consider how to grade students logging into the student-shell SSH
 server. We store the list of students' Canvas and KTH IDs in a file.