Update README.md

btzy · Jul 23, 2017 · 01bac1d · 01bac1d
1 parent 0daa662
commit 01bac1d
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # autotimetable
-Automatic timetable generation engine for NUS modules
+
+## Notes
+
+The input `modules.json` file uses the NUSMods API format.  You can download an updated copy of `modules.json` from there.
+
+## Command-line usage
+
+`autotimetable --modulefile=<filename> --required=<comma-separated module list>`
+
+### Example
+
+`autotimetable --modulefile=modules.json --required=CS1010,MA1101R,CS1231,BN1101,GET1002`
+
+Do not put any spaces in the module list!